Skip to content

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

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

harryswift01 merged 3 commits into
mainfrom
85-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme

Conversation

@harryswift01

@harryswift01 harryswift01 commented Nov 4, 2026 •

Copy link
Copy Markdown
Member

Summary

This PR moves the template's documentation to the shared CCPBioSim Sphinx theme (ccpbiosim-sphinx-theme) and the docs/source layout, so new projects start with the same setup as the rest of the CCPBioSim repositories.

Changes

  • Move the documentation into docs/source, and update the Makefile and .readthedocs.yaml.
  • Replace Furo and the old docs extensions with ccpbiosim-sphinx-theme and sphinx-autoapi in the docs dependencies.
  • Generate the API reference with sphinx-autoapi and read the release from the installed package.
  • Add a banner, quick start and section cards to the home page, with comments on what to change.
  • Remove pytest-sugar, which crashes with pytest 9.2 when run in a terminal.

Testing

  • Built the docs with make -C docs html SPHINXOPTS="-W --keep-going" with no warnings.
  • Ran the tests and all pre-commit hooks.
  • Checked the home page, the API pages and the "Edit on GitHub" links.

Impact

  • New projects created from the template start with the shared theme, the docs/source layout and a generated API reference.
  • Existing projects are unaffected.

Checklist

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

@harryswift01 harryswift01 self-assigned this Nov 4, 2026
@harryswift01 harryswift01 added the documentation Improvements or additions to documentation label Nov 4, 2026
@harryswift01 harryswift01 linked an issue Nov 4, 2026 that may be closed by this pull request
@harryswift01 harryswift01 added the enhancement New feature or request label Nov 4, 2026
@harryswift01
harryswift01 merged commit d7cfc2a into main Nov 4, 2026
14 checks passed
@harryswift01
harryswift01 deleted the 85-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme branch November 4, 2026 10:45
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

1 participant