docs: flesh out the documentation landing page - #7
Merged
Conversation
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.
The docs landing page was a bare
toctree(the live index rendered ~700 chars: just the title and "Indices and tables"), so the site read as a stub even though the API reference built fine on the subpages.This rewrites
index.rstwith a conventional landing page - short overview, installation (core + extras), and a quickstart (registry +build()+serialize()), then the toctree to the API reference. Mirrors the structure used in observer-pattern's docs.Built locally with
sphinx-build: landing page now ~3.2k chars with Installation/Quick start/example present. No source code touched.