From b3660389764f58c0b43e7e600bb91911652bfd56 Mon Sep 17 00:00:00 2001 From: Brooks Smith <42363318+smith120bh@users.noreply.github.com> Date: Tue, 2 Jun 2026 20:50:23 +1000 Subject: [PATCH 1/3] Add a workflow file to trigger RTD builds --- .github/workflows/readthedocs.yml | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 .github/workflows/readthedocs.yml diff --git a/.github/workflows/readthedocs.yml b/.github/workflows/readthedocs.yml new file mode 100644 index 0000000..f3276cb --- /dev/null +++ b/.github/workflows/readthedocs.yml @@ -0,0 +1,18 @@ +name: Trigger RTD build + +on: + release: + types: [published, edited] + push: + branches: [docs*] + +jobs: + trigger-rtd: + runs-on: ubuntu-latest + steps: + - name: Trigger Read the Docs build + run: | + curl -X POST \ + -d "branches=${{ github.ref_name }}" \ + -d "token=${{ secrets.RTDS_WEBHOOK_TOKEN }}" \ + "${{ secrets.RTDS_WEBHOOK_URL }}" \ No newline at end of file From ed5ef08d6424dc8bfd5fc2e6aa8b85f94cbb010f Mon Sep 17 00:00:00 2001 From: Brooks Smith <42363318+smith120bh@users.noreply.github.com> Date: Tue, 2 Jun 2026 21:03:38 +1000 Subject: [PATCH 2/3] Only trigger on master merges to avoid branch awareness weirdness --- .github/workflows/readthedocs.yml | 8 +++++++- 1 file changed, 7 insertions(+), 1 deletion(-) diff --git a/.github/workflows/readthedocs.yml b/.github/workflows/readthedocs.yml index f3276cb..175531b 100644 --- a/.github/workflows/readthedocs.yml +++ b/.github/workflows/readthedocs.yml @@ -4,7 +4,13 @@ on: release: types: [published, edited] push: - branches: [docs*] + branches: [master] + paths: + - 'docs/**' + - '*.rst' + - '*.md' + - 'readthedocs.yml' + - '.readthedocs.yaml' jobs: trigger-rtd: From 2661bd7e3e4987f900a4662712145de69fb20057 Mon Sep 17 00:00:00 2001 From: Brooks Smith <42363318+smith120bh@users.noreply.github.com> Date: Tue, 2 Jun 2026 21:17:23 +1000 Subject: [PATCH 3/3] Update conf.py, add an _version.py --- anastruct/_version.py | 1 + docs/source/conf.py | 181 ++++++------------------------------------ 2 files changed, 24 insertions(+), 158 deletions(-) create mode 100644 anastruct/_version.py diff --git a/anastruct/_version.py b/anastruct/_version.py new file mode 100644 index 0000000..51bbb3f --- /dev/null +++ b/anastruct/_version.py @@ -0,0 +1 @@ +__version__ = "1.6.2" diff --git a/docs/source/conf.py b/docs/source/conf.py index affe497..2f04285 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -1,179 +1,44 @@ -#!/usr/bin/env python3 -# -*- coding: utf-8 -*- -# -# anaStruct documentation build configuration file, created by -# sphinx-quickstart on Fri Sep 1 17:34:46 2017. -# -# This file is execfile()d with the current directory set to its -# containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -# -import os -import sys - -sys.path.insert(0, os.path.abspath("../../")) - -import sphinx_rtd_theme - -html_theme = "sphinx_rtd_theme" -# html_theme_path = [sphinx_rtd_theme.get_html_theme_path()] +from anastruct._version import __version__ +# -- Project information +project = "anaStruct" +copyright = "2018, Ritchie Vink" +author = "Ritchie Vink" +maintainer = "Brooks Smith" -# -- General configuration ------------------------------------------------ +release = __version__ +version = __version__ -# If your documentation needs a minimal Sphinx version, state it here. -# -# needs_sphinx = '1.0' +# -- General configuration -# Add any Sphinx extension module names here, as strings. They can be -# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom -# ones. extensions = [ "sphinx.ext.autodoc", "sphinx.ext.mathjax", "sphinx.ext.viewcode", "sphinx_autodoc_typehints", + "sphinx.ext.autosummary", + "sphinx.ext.intersphinx", + "autoapi.extension", ] +autoapi_dirs = ["../../anastruct"] -# Add any paths that contain templates here, relative to this directory. -templates_path = ["_templates"] +intersphinx_mapping = { + "python": ("https://docs.python.org/3/", None), + "sphinx": ("https://www.sphinx-doc.org/en/master/", None), +} +intersphinx_disabled_domains = ["std"] -# The suffix(es) of source filenames. -# You can specify multiple suffix as a list of string: -# -# source_suffix = ['.rst', '.md'] -source_suffix = ".rst" +templates_path = ["_templates"] -# The master toctree document. master_doc = "index" -# General information about the project. -project = "anaStruct" -copyright = "2018, Ritchie Vink" -author = "Ritchie Vink" - -# The version info for the project you're documenting, acts as replacement for -# |version| and |release|, also used in various other places throughout the -# built documents. -# -# The short X.Y version. -version = "1.0" -# The full version, including alpha/beta/rc tags. -release = "1.0" - -# The language for content autogenerated by Sphinx. Refer to documentation -# for a list of supported languages. -# -# This is also used if you do content translation via gettext catalogs. -# Usually you set "language" from the command line for these cases. -language = None - -# List of patterns, relative to source directory, that match files and -# directories to ignore when looking for source files. -# This patterns also effect to html_static_path and html_extra_path -exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] - -# The name of the Pygments (syntax highlighting) style to use. pygments_style = "sphinx" -# If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = False - - -# -- Options for HTML output ---------------------------------------------- - -# The theme to use for HTML and HTML Help pages. See the documentation for -# a list of builtin themes. -# -# html_theme = 'alabaster' - -# Theme options are theme-specific and customize the look and feel of a theme -# further. For a list of options available for each theme, see the -# documentation. -# -# html_theme_options = {} - -# Add any paths that contain custom static files (such as style sheets) here, -# relative to this directory. They are copied after the builtin static files, -# so a file named "default.css" will overwrite the builtin "default.css". -html_static_path = ["_static"] - -# Custom sidebar templates, must be a dictionary that maps document names -# to template names. -# -# This is required for the alabaster theme -# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars -html_sidebars = { - "**": [ - "about.html", - "navigation.html", - "relations.html", # needs 'show_related': True theme option to display - "searchbox.html", - "donate.html", - ] -} - - -# -- Options for HTMLHelp output ------------------------------------------ - -# Output file base name for HTML help builder. +# -- Options for HTML output htmlhelp_basename = "anaStructdoc" -# -- Options for LaTeX output --------------------------------------------- - -latex_elements = { - # The paper size ('letterpaper' or 'a4paper'). - # - # 'papersize': 'letterpaper', - # The font size ('10pt', '11pt' or '12pt'). - # - # 'pointsize': '10pt', - # Additional stuff for the LaTeX preamble. - # - # 'preamble': '', - # Latex figure (float) alignment - # - # 'figure_align': 'htbp', -} - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, -# author, documentclass [howto, manual, or own class]). -latex_documents = [ - (master_doc, "anaStruct.tex", "anaStruct Documentation", "Ritchie Vink", "manual"), -] - - -# -- Options for manual page output --------------------------------------- - -# One entry per manual page. List of tuples -# (source start file, name, description, authors, manual section). -man_pages = [(master_doc, "anastruct", "anaStruct Documentation", [author], 1)] - - -# -- Options for Texinfo output ------------------------------------------- +html_theme = "sphinx_rtd_theme" -# Grouping the document tree into Texinfo files. List of tuples -# (source start file, target name, title, author, -# dir menu entry, description, category) -texinfo_documents = [ - ( - master_doc, - "anaStruct", - "anaStruct Documentation", - author, - "anaStruct", - "One line description of project.", - "Miscellaneous", - ), -] +# -- Options for EPUB output +epub_show_urls = "footnote"