Update docs#108
Draft
kwabenantim wants to merge 2 commits into
Draft
Conversation
- conf.py + pyproject: use the Furo theme (matches pybind11) instead of sphinx-rtd-theme. - doc/Makefile: add a `livehtml` target (sphinx-autobuild) that rebuilds on save and watches the cppwg package so docstring edits refresh the autodoc pages; add sphinx-autobuild to the docs extra. - README: add a docs build-status badge linking to the site, and document the live-reload dev server. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Reorganise the Sphinx site around task-focused pages: - Split the home page into an Installation page (dependencies, CastXML superbuild note, cppwg install) and a First steps page (worked shapes example, command-line usage, tips). The home page is now a landing page with a Contents toctree. - Remove the autodoc API reference page and its now-unused Sphinx config (autodoc, napoleon, viewcode, coverage, mock imports) and the empty Indices toctree it fed. - Add sphinx-copybutton so code blocks get a copy button. - Let Furo apply its own Pygments styling instead of the forced green "sphinx" theme; drop the version from the sidebar brand title. - Prose, link, and formatting fixes throughout. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Follow-up to close #106