Restore genindex via a stub document - #14
Merged
Merged
Conversation
#13 dropped the genindex toctree entry to fix the singlehtml/htmlzip build, which also removed the General Index nav entry. The praw-dev libraries instead ship a stub docs/genindex.rst so the toctree entry resolves to a real document and singlehtml builds cleanly while keeping the Index in the nav. Adopt that approach here for consistency.
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 #13, aligning CodeSorter with the praw-dev docs convention.
#13 fixed the
htmlzip/singlehtml build failure by removing thegenindextoctree entry — but that also dropped the General Index entry from the docs navigation. The praw libraries (praw/prawcore/asyncpraw/asyncprawcore) handle this differently: they ship a stubdocs/genindex.rst(just an "Index" title), so the toctree entry resolves to a real document —singlehtmlbuilds cleanly and the Index stays in the nav.This PR adopts that same approach: adds
docs/genindex.rstand restores thegenindextoctree entry indocs/index.rst.Verified against the RTD env (Python 3.14, Sphinx 9.1.0): both
-b html(-W -n) and-b singlehtml(-W) build clean; pre-commit passes.