docs: fix Read the Docs build configuration - #306
Merged
Merged
Conversation
- .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)
The 5.0.1 section uses a '##### Tests' category heading that prepare_changelog.py did not recognize, so the generated docs/source/changelog.md drifted from the committed file and the Sphinx build warns 'Non-consecutive header level increase; H3 to H5'. Adding Tests to the category list keeps the generated changelog in sync and removes the warning.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The readthedocs.io build configuration was broken (verified against the repo tree):
sphinx.configuration: docs/conf.py— that file does not exist. The Sphinx config isdocs/source/conf.py(which is what the Makefile and the toxdocsenv use).python.install: requirements: dev-requirements.txt— that file does not exist either. Replaced with a pip install of the project itself plus itsdocsextras, which define the actual Sphinx dependencies (Sphinx, myst-parser, sphinx-rtd-theme, sphinx-copybutton, alabaster) in pyproject.toml.Also:
requires-python = ">=3.11".aprsd.cmds.export_configandaprsd.cmds.export_pluginsmodules (CI regenerates apidoc on the fly, so only the committed copy RTD uses was stale).Local verification:
tox -edocs(runs clean_docs.py, prepare_changelog.py, fix_readme_rst.py, sphinx-apidoc, sphinx-build).