sphinx

sphinx copied to clipboard

[autodoc] add support for ``python_display_short_literal``

9

Closes #11995. @user27182 Could you check if this patch works? I added a test but since I refactored autodoc for that, I want to be sure that I didn't forget...

picnixz

config to control the toc depth for a page and/or project

14

**Is your feature request related to a problem? Please describe.** From https://github.com/pradyunsg/furo/discussions/557: For one of my projects, the right nav for the API reference has become unusable: it lists sections...

cjw296

I’m guessing this section was copied over from the previous one and these bits got forgotten when updating. I’m also wondering whether there is a missing “at an” before “earlier...

afranke

Add the documentation for #12018. I'll keep both in sync if the implementation changes. So for now, I'll keep it as a draft. EDIT: will sync afterwards

picnixz

**Is your feature request related to a problem? Please describe.** *Goal* I would like to add a toc entry to each ``.. autofunction:`` Suppose: ```rst .. automodule:: foo.bar .. rubric::...

tdegeus

autodoc for generic classes should include the type parameters

16

Currently, when autodoc renders a class of the form `class Foo(Generic[T])`, the resulting HTML just shows "class modulename.Foo", which omits information, as the type parameter is not shown. The only...

jwodder

Intersphinx :any: references to link targets with capital letters fails

6

Unzip [Sphinx_projects.zip](https://github.com/sphinx-doc/sphinx/files/6123862/Sphinx_projects.zip), then: ``` cd two make html cd ../one make html ``` This illustrates the following problems: From `one/index.rst` =================  From `two/index.rst` ===================  Bugs observed =============== 1....

bjones1

If `index.rst` does not appear in the pattern of a custom `{include,exclude}_patterns`, the error message is less than helpful. Instead, we should check that the master doc appears in the...

AA-Turner

fix #11446: linkcheck should split url only if # part of anchor

13

fixes #11446 as described in the issue, the link checker incorrectly processes URLs that have a `#` that is part of the directory path, rather than designating the anchor. This...

rsokolewicz

Fix rendering of enumerations inheriting from mixin and data types.

1

Fix #11353. I'm not sure that everything is covered so feel free to argue.

picnixz