Skip to content

Move the documentation to the shared CCPBioSim Sphinx theme - #56

Merged
harryswift01 merged 5 commits into
mainfrom
53-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme
Nov 4, 2026
Merged

harryswift01 merged 5 commits into
mainfrom
53-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme

Conversation

@harryswift01

Copy link
Copy Markdown
Member

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

  • Replace Furo and the old docs extensions with ccpbiosim-sphinx-theme and sphinx-autoapi in the docs dependencies.
  • Set the theme in conf.py, read the release from the installed package, and remove the autodoc mocks and repeated settings.
  • Generate the API reference with sphinx-autoapi instead of the committed sphinx-apidoc files.
  • Add a banner, quick start and section cards to the home page, with short labels in the navigation.
  • Fix the score_pdb_map docstring so its arguments render.
  • Ignore docs/build, the folder the Makefile builds into.

Testing

  • Built the docs with make -C docs html SPHINXOPTS="-W --keep-going" with no warnings.
  • Checked the home page in light and dark mode, the guide and API pages, and the "Edit on GitHub" links.

Impact

  • Docs changes, plus a docstring fix in prepmd/point_cloud.py.
  • The API reference now has one page per module and is generated on each build.
  • API page URLs change from api/... to reference/....

Checklist

  • Tests added or updated
  • Documentation updated
  • If dependencies in pyproject.toml changed, the lower bounds were reviewed deliberately

@harryswift01
harryswift01 requested a review from jimboid November 3, 2026 16:25
@harryswift01 harryswift01 self-assigned this Nov 3, 2026
@harryswift01 harryswift01 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 3, 2026
@harryswift01 harryswift01 linked an issue Nov 3, 2026 that may be closed by this pull request

@jimboid jimboid left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great!

@harryswift01
harryswift01 merged commit ff09c07 into main Nov 4, 2026
7 checks passed
@harryswift01
harryswift01 deleted the 53-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme branch November 4, 2026 09:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docs: Move the documentation to the shared CCPBioSim Sphinx theme

2 participants