Skip to content

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

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

harryswift01 merged 10 commits into
mainfrom
111-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme

Conversation

@harryswift01

Copy link
Copy Markdown
Member

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

  • 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 Google-style docstrings (which the package uses), and read the release from the installed package.
  • Generate the API reference with sphinx-autoapi, removing the committed sphinx-apidoc files, the Makefile api-docs target and the Read the Docs pre-build step.
  • Add a banner and section cards to the home page, with short labels in the navigation.
  • Fix the funding section on the home page, which named biosim-schema.

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 pages and screenshots, the API pages, the "Edit on GitHub" links and the copy buttons.

Impact

  • Docs only, no changes to the biosimdb-interface package.
  • Docstring Args: and Returns: sections now render as parameter lists in the API reference.
  • API page URLs change from api_generated/... to reference/....

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 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
…umentation-to-the-shared-ccpbiosim-sphinx-theme
@harryswift01
harryswift01 requested a review from jkalayan November 3, 2026 12:02

@jkalayan jkalayan left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Happy to see the biosimdb interface docs align with the CCPBioSim theme for docs, looks great Harry!

@harryswift01
harryswift01 merged commit 7967436 into main Nov 4, 2026
12 checks passed
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