sphinx
sphinx copied to clipboard
The Sphinx documentation generator
### Describe the bug If you have a toctree that includes another toctree, then run `make latexpdf`, you will get a warning that there are multiply-defined labels. ### How to...
Subject: Fix duplicate search results ### Feature or Bugfix - Bugfix ### Purpose We currently list the same page multiple times if, for example, both the title and content search...
there are two sources of truth for docutils type annotations. this repo uses `docutils-stubs`, but there's also typeshed annotations - `types-docutils`. Neither are complete, nor is one a subset of...
### Feature or Bugfix - Feature (adjustment) ### Purpose - Makes the distinct `linkcheck` status code for `timeout` opt-in instead of always-enabled. - I've been worrying about potential downstream linkchecker-reporting...
Subject: Provide a better error message if the master document is not included in project documents [#11873] ### Feature or Bugfix - Bugfix - Refactoring ### Purpose - Provide a...
closes #12007 I expect this to be a long-running PR which will help identify gaps in the typeshed docutils libraries. Once all the issues are squashed upstream this can be...
Closes #11285. Documentation will be in a separate PR. Note that this PR must be merged after #12017.
### Feature or Bugfix - Bugfix ### Purpose - Fixes a bug that prevents partially-matched titles from Sphinx documentation projects from appearing during search results (for example, a section titled...
### Feature or Bugfix - Feature (tests) ### Purpose - Improve the test coverage of the `searchtools.js` search index/querying functionality, to aid maintenance and development. ### Detail - [ ]...
the return type here should be `Sequence` rather than `list` since it uses the super class method which is typed as `Sequence`