sphinx

sphinx copied to clipboard

### Describe the bug Hello, I would like to use the autosummary+recusive logic to document the API of a python library. My code is inspired on [JamesALeedham](https://github.com/JamesALeedham/Sphinx-Autosummary-Recursion) example and available...

achoum

Shortening long intersphinx cross-references while keeping library explicit

3

I'm working with some external libraries which have most of their common classes defined in modules nested two layers deep, so I'm repeatedly having to write things like `sympy.core.symbol.Symbol` everywhere...

jlumpe

Considering the following toc for index: ``` .. toctree:: a b ``` where a has: ``` .. toctree:: a1 a2 ``` and b has: ``` .. toctree:: b1 b2 ```...

mgoulao

escaping curly braces in samp text role broken

2

### Describe the bug Escaping of curly braces in the `samp` text role was introduced in #4909, but it does not seem to be able to handle both escaped and...

rdzman

This PR fixes a typo in the `KeyboardTransform` logic for `:kbd:` roles. ### Feature or Bugfix - [ ] ~~Feature~~ - [x] **Bugfix** - [ ] ~~Refactoring~~ ### Purpose Each...

Alhadis

`napoleon_attr_annotations` doesn't work for class instance attributes

1

### Describe the bug I am using the napoleon extension for my google-style docstrings. Since the code already has type annotations i do not want to repeat those in the...

Skylake-dev

Subject: doc: add note on unsupported include directive for source-read event content modification ### Purpose - Files included with the `include` directive have their content available in the source-read event...

QSchulz

HTML Search: omit anchor reference from document titles in the search index.

23

### Feature or Bugfix - Bugfix ### Purpose - Adjusts the contents of the search-index provided to the client so that the browser correctly de-duplicates search results that link to...

jayaddison

[tracker] Issues related to autodoc and "undefined reference"

3

This issue serves as a tracker for issues related to autodoc and its inhability to render types. Feel free to dump the issues you find relevant and I'll add them...

picnixz

Imported string constant has wrong docstring of `str`

4

### Describe the bug When a string constant is imported, sphinx cannot find the docstring of the original definition (in the module form where it was imported). Instead, it gives...

aeisenbarth