Sphinx-generated documentation#106

Open

woodtp wants to merge 25 commits into

mainfrom

feature/documentation

Commits on Jan 12, 2026

init sphinx
Wood, Tony
committed
sphinx-apidoc first pass
Wood, Tony
committed
autosummary working. Mostly.
Wood, Tony
committed
Doxygen + breathe + exhale
Wood, Tony
committed
Should be api not _api
Wood, Tony
committed
Remove duplicates in C++ docs
Wood, Tony
committed
Write a new workflow to automatically build and publish docs to GH Pages
Wood, Tony
committed
Don't build docs on PR
Wood, Tony
committed

Commits on Jan 13, 2026

Add markdown support and 'copy' button on codeblocks
Wood, Tony
committed
formatting
Wood, Tony
committed
remove comments
Wood, Tony
committed
split into two jobs so that build and deploy can be re-run independently if necessary
Wood, Tony
committed
Extend deploy job timeout to 1 hour
Wood, Tony
committed
Move doc building to a resuable workflow
Wood, Tony
committed
this needs quotes ..?
Wood, Tony
committed
Revert "this needs quotes ..?"
Wood, Tony
committed

Commits on Jan 15, 2026

Adjust workflow to deploy to pyorbit-collaboration/pyorbit-collaboration.github.io
Wood, Tony
committed
Split cpp and python autoapi into separate dirs, introduce automodapi and separate markdown files for each pyorbit module
Wood, Tony
committed
Adjustments to the __init__.py of orbit modules to make the docs compilable
Wood, Tony
committed
missing deps, move env file to doc/
Wood, Tony
committed
Restructure for cleaner website
Wood, Tony
committed
Automatically document based on typehints, if available
Wood, Tony
committed

Commits on Jan 16, 2026

fix mesonbuild.md warning
Wood, Tony
committed
Some example docstrings and correcting warnings related to formatting.
Wood, Tony
committed
needs a space here
Wood, Tony
committed