Skip to content

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

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

harryswift01 merged 3 commits into
mainfrom
86-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 SIST documentation to the shared CCPBioSim Sphinx theme (ccpbiosim-sphinx-theme), so it matches the rest of the CCPBioSim repositories.

Changes

  • Replace Furo and the unused docs packages (nbsphinx, sphinx_copybutton, sphinxcontrib-contentui and sphinxcontrib-details-directive) with ccpbiosim-sphinx-theme in docs/requirements.txt.
  • Set the theme in conf.py and remove the Furo logo options and unused extensions.
  • Add a banner, quick start tabs and section cards to the home page, with short labels in the navigation.
  • Stop ignoring docs/source/_autosummary/, which is no longer generated.

Testing

  • Built the docs in a fresh environment from docs/requirements.txt with make -C docs html SPHINXOPTS="-W --keep-going" with no warnings.
  • Checked the home page in light and dark mode, the guide pages, the example downloads and the "Edit on GitHub" links.

Impact

  • Docs changes only. The page content is the same apart from the home page layout.
  • No API reference is added, as SIST is used through the sist command.
  • The CI and Read the Docs setup already use docs/requirements.txt and docs/source, so they are unchanged.

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 4, 2026 10:47
@harryswift01 harryswift01 self-assigned this Nov 4, 2026
@harryswift01 harryswift01 added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 4, 2026
@harryswift01 harryswift01 linked an issue Nov 4, 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 good

@harryswift01
harryswift01 merged commit 40ac11a into main Nov 4, 2026
20 checks passed
@harryswift01
harryswift01 deleted the 86-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme branch November 4, 2026 11:06
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