sphinx

sphinx copied to clipboard

Autosummary : autosummary_ignore_module_all does not work as documented

2

### Describe the bug As per documentation : > Note that if an imported member is listed in `__all__`, it will be documented regardless of the value of autosummary_imported_members. So...

ClementPinard

Inherited docstrings of TypeDict subclasses are missing

7

**Is your feature request related to a problem? Please describe.** Currently sphinx understands to produce the documented annotations of a TypedDict subclass thanks to #7486 TypedDict subclasses can themselves be...

obriencj

Fix autodoc for `typing.TypedDict` inheritance

8

Subject: enable listing inherited members of `TypedDict` subclasses ### Feature or Bugfix - Bugfix ### Purpose - fix inherited members not showing up for subclasses of `TypedDict` ### Detail -...

krassowski

Text following notes and warnings stay embedded inside the note or warning box

3

### Describe the bug When building documentation, text following calls to ```.. warning::``` or ```.. note::``` stay embedded inside the warning or note box. ### How to Reproduce ``` $...

sofian

Option for display mode of Optional[Union].

1

**Is your feature request related to a problem? Please describe.** If I use typehints like this, I get the same result as expected from the documentation. in code: ```python def...

Sangwon91

label system of math directive is confusable

4

### Problem In reST world, usually, we have two ways to give a label to an arbitrary node which is generated by directive. The first way is hyperlink target. And...

tk0miya

We previously did DNS configuration for HTTPS on `www.sphinx-doc.org` on #5522 (Fall 2018). At the time, the official ReadTheDocs documentation stated that "ReadTheDocs doesn't support naked domains.", but now it...

shimizukawa

### Describe the bug Not a big deal, but since reporting is encouraged according to the message: On CI with 3.6: ``` Exception occurred: File "/usr/local/lib/python3.6/os.py", line 800, in fsencode...

oscargus

Default FreeSerif font not found by xelatex due to specifying Extension

1

### Describe the bug When specifying the latex engine as `latex_engine = 'xelatex'`, the generated .tex file has the following font configuration: ``` \setmainfont{FreeSerif}[ Extension = .otf, UprightFont = *,...

apteryks

Draw square boxes around automatically parsed Python types instead of pure HTML links

4

**Is your feature request related to a problem? Please describe.** There is no real problem, rather aesthetics. **Describe the solution you'd like** I would like to have a box around...

1kastner