From 96552e5f712eb6a1d4aefb2d0a4bf4184ee505e0 Mon Sep 17 00:00:00 2001 From: Walter Boring Date: Sun, 20 Sep 2026 15:40:36 -0400 Subject: [PATCH] docs: fix Read the Docs build configuration - .readthedocs.yaml pointed at docs/conf.py (does not exist); the Sphinx config is docs/source/conf.py - .readthedocs.yaml installed dev-requirements.txt (does not exist); install the project with its docs extras instead (Sphinx, myst-parser, sphinx-rtd-theme, sphinx-copybutton, alabaster) - install.rst: Python 3.6 or later -> 3.11 (pyproject requires-python >=3.11) - Regenerate docs/source/apidoc (was missing the new aprsd.cmds.export_config and aprsd.cmds.export_plugins modules) --- .readthedocs.yaml | 11 +++++++---- docs/source/apidoc/aprsd.cmds.rst | 16 ++++++++++++++++ docs/source/install.rst | 2 +- 3 files changed, 24 insertions(+), 5 deletions(-) diff --git a/.readthedocs.yaml b/.readthedocs.yaml index 9caa041..cafd51d 100644 --- a/.readthedocs.yaml +++ b/.readthedocs.yaml @@ -12,12 +12,15 @@ build: tools: python: "3.11" -# Build documentation in the docs/ directory with Sphinx +# Build documentation in the docs/source directory with Sphinx sphinx: - configuration: docs/conf.py + configuration: docs/source/conf.py -# We recommend specifying your dependencies to enable reproducible builds: +# Install the project with its docs extras (Sphinx, myst-parser, theme): # https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html python: install: - - requirements: dev-requirements.txt + - method: pip + path: . + extra_requirements: + - docs diff --git a/docs/source/apidoc/aprsd.cmds.rst b/docs/source/apidoc/aprsd.cmds.rst index 9b3edb1..469cab9 100644 --- a/docs/source/apidoc/aprsd.cmds.rst +++ b/docs/source/apidoc/aprsd.cmds.rst @@ -20,6 +20,22 @@ aprsd.cmds.dev module :show-inheritance: :undoc-members: +aprsd.cmds.export\_config module +-------------------------------- + +.. automodule:: aprsd.cmds.export_config + :members: + :show-inheritance: + :undoc-members: + +aprsd.cmds.export\_plugins module +--------------------------------- + +.. automodule:: aprsd.cmds.export_plugins + :members: + :show-inheritance: + :undoc-members: + aprsd.cmds.fetch\_stats module ------------------------------ diff --git a/docs/source/install.rst b/docs/source/install.rst index d904432..4e60979 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -4,7 +4,7 @@ APRSD installation Install info in a nutshell -------------------------- -**Pythons**: Python 3.6 or later +**Pythons**: Python 3.11 or later **Operating systems**: Linux, OSX, Unix