Repository navigation
Move the documentation to the shared CCPBioSim Sphinx theme - #56
Merged
harryswift01 merged 5 commits intoNov 4, 2026
Merged
harryswift01 merged 5 commits into
harryswift01 merged 5 commits into
Conversation
…sphinx-theme and sphinx-autoapi
…ence with sphinx-autoapi
harryswift01
deleted the
53-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme
branch
November 4, 2026 09:13
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
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.
Summary
This PR moves the prepmd documentation to the shared CCPBioSim Sphinx theme (ccpbiosim-sphinx-theme) and generates the API reference with
sphinx-autoapi.Changes
ccpbiosim-sphinx-themeandsphinx-autoapiin thedocsdependencies.conf.py, read the release from the installed package, and remove the autodoc mocks and repeated settings.sphinx-autoapiinstead of the committedsphinx-apidocfiles.score_pdb_mapdocstring so its arguments render.docs/build, the folder the Makefile builds into.Testing
make -C docs html SPHINXOPTS="-W --keep-going"with no warnings.Impact
prepmd/point_cloud.py.api/...toreference/....Checklist
pyproject.tomlchanged, the lower bounds were reviewed deliberately