sphinx
sphinx copied to clipboard
sphinx-doc
The Sphinx documentation generator
### Feature or Bugfix - Feature ### Purpose This pull request adds a `py:type` directive for documenting type aliases (https://typing.readthedocs.io/en/latest/spec/aliases.html#type-aliases), and a `py:type` role for linking to them. ```rst .....
Subject: Fix singlehtml target uris to be same-document references ### Feature or Bugfix - Feature (Output quality improvement) ### Purpose Before this change, target_uris would be generated as `index.html#foo`. This...
### Feature or Bugfix - Refactoring ### Purpose - Use `StrEnum` values to provide type-checkable linkcheck status codes. ### Detail - Requires Python 3.11, for [`StrEnum` support](https://docs.python.org/3.11/whatsnew/3.11.html#enum). - Removes an...
### Describe the bug When importing a function from a module of same name, the module is documented in the group "Modules" but with function signature. This is a problem,...
### Describe the bug When using autosummary with recursion and option `:nosignatures:`, the option is only applied to the top level and not passed on to submodules. This is a...
### Describe the bug If you have two classes with the same name and have quotes around a type annotation when referencing one of them, you get the warning` more...
**Is your feature request related to a problem? Please describe.** I am grouping together a number of topics under a common topic in the index, mostly server names grouped by...
Fix #11711. Since the logic is different, this required a complete update on how intersphinx inventories are represented. Before, each line in an inventory was of the form ``` name...
### Describe the bug Sphinx processes and outputs type hints differently to html depending on * the use of quotes on type hints (`"Type" vs Type`), * if `__future__.annotations` is...
I was documenting the testing module in #11972 when I saw that some of the signatures I have are a bit too long. Instead of enabling #11011 for the whole...