Repository navigation
Move the documentation to the shared CCPBioSim Sphinx theme - #112
Merged
harryswift01 merged 10 commits intoNov 4, 2026
Merged
harryswift01 merged 10 commits into
harryswift01 merged 10 commits into
Conversation
…-sphinx-theme` and `sphinx-autoapi`
…umentation-to-the-shared-ccpbiosim-sphinx-theme
jkalayan
approved these changes
Nov 4, 2026
jkalayan
left a comment
Collaborator
There was a problem hiding this comment.
Happy to see the biosimdb interface docs align with the CCPBioSim theme for docs, looks great Harry!
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 biosimdb-interface 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 Google-style docstrings (which the package uses), and read the release from the installed package.sphinx-autoapi, removing the committedsphinx-apidocfiles, the Makefileapi-docstarget and the Read the Docs pre-build step.Testing
make -C docs html SPHINXOPTS="-W --keep-going"with no warnings.Impact
Args:andReturns:sections now render as parameter lists in the API reference.api_generated/...toreference/....Checklist
pyproject.tomlchanged, the lower bounds were reviewed deliberately