Skip to content

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

Merged
harryswift01 merged 14 commits into
mainfrom
481-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme
Oct 30, 2026
Merged

harryswift01 merged 14 commits into
mainfrom
481-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme

Conversation

@harryswift01

@harryswift01 harryswift01 commented Oct 30, 2026 •

Copy link
Copy Markdown
Member

Summary

This PR moves the CodeEntropy documentation to the shared CCPBioSim Sphinx theme (ccpbiosim-sphinx-theme) and generates the API reference with sphinx-autoapi.

Changes

  • Replace Furo with ccpbiosim-sphinx-theme and set the theme in conf.py.
  • Add a banner, quick start and section cards to the home page, with short labels in the navigation.
  • Generate the API reference with sphinx-autoapi instead of sphinx-apidoc, so the files in docs/api/ and the autodoc mocks are no longer needed.
  • Show constructor arguments from __init__ docstrings in the API reference.
  • Remove nbsphinx, sphinx_copybutton, sphinx.ext.autodoc and sphinx.ext.autosummary, which are no longer needed or are loaded by other extensions.
  • Move the documentation into docs/source to match the other CCPBioSim repositories, and update the Makefile, readthedocs.yml and README logo paths.
  • Remove leftover files to match the Python template, and fix the build instructions in the developer guide.

Testing

  • Built the docs with make -C docs html SPHINXOPTS="-W --keep-going" with no warnings.
  • Checked the home page, API, Science and Getting Started pages, the "Edit on GitHub" links and the copy buttons.

Impact

  • Docs only, no changes to the CodeEntropy package.
  • The docs build no longer imports CodeEntropy, so MDAnalysis, rdkit and waterEntropy are not needed to build them.
  • 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 added this to the 2.7.0 milestone Oct 30, 2026
@harryswift01 harryswift01 self-assigned this Oct 30, 2026
@harryswift01 harryswift01 added documentation Improvements or additions to documentation dependencies Pull requests that update a dependency file labels Oct 30, 2026
@harryswift01 harryswift01 linked an issue Oct 30, 2026 that may be closed by this pull request
@harryswift01
harryswift01 marked this pull request as ready for review October 30, 2026 13:01

@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.

This is great work. Happy to see this merged in and spammed to other repos.

@harryswift01
harryswift01 merged commit dbcf230 into main Oct 30, 2026
23 checks passed
@harryswift01
harryswift01 deleted the 481-docs-move-the-documentation-to-the-shared-ccpbiosim-sphinx-theme branch October 30, 2026 14:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

dependencies Pull requests that update a dependency file documentation Improvements or additions to documentation

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