sphinx

sphinx copied to clipboard

The HTML5 writer should render hlist nodes with CSS columns

1

Currently, Sphinx includes [the `hlist` directive](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-hlist) which produces a bulleted list split into multiple columns. [Internally](https://github.com/sphinx-doc/sphinx/blob/8effd151b9d705a6d4830feb709584fdc26d6046/sphinx/directives/other.py#L278-L285), it splits the list up into as many equal-sized pieces as there are columns....

Screwtapello

make examples 'type safe'

2

This project is making admirable progress towards a fully type-annotated code base. The tutorials/examples are *not* type annotated, and in fact fail a `mypy` run. We should set a good...

danieleades

Fully qualified types are generated with autodoc 'short' typehint format for class attributes

5

### Describe the bug When a python class attribute has a type annotation, the generated documentation will show the fully qualified class name, even with `autodoc_typehints_format = 'short'`. Example: ```...

jzombi

### Describe the bug unknown extra arguments. It reports 11 positional arguments given, but I only found 10. In [custom extension quickstart.py](https://github.com/Ares-Developers/Ares-docs/blob/tagroles/exts/quickstart.py),line 38~40 ` ad = make_admonition(quickstart, self.name, ['Quickstart'], self.options,...

sovzzz

Regression in agogo theme

2

### Describe the bug Pull request #10520 introduced a regression in the display of the Table of Content of the `agogo` theme. The `agogo` sample can be seen here: https://sphinx-themes.org/sample-sites/default-agogo/...

gvimont

Ability to disable capitalisation on field names.

1

I would like to use field lists to describe function parameters in my library's documentation. Unfortunately the first character in the field name is automatically capitalised, which makes it not...

exelotl

Make toctree accept 'genindex', 'modindex' and 'search' docnames

2

Subject: Make toctree accept 'genindex', 'modindex' and 'search' docnames ### Feature or Bugfix Bugfix ### Relates Fixes #8438

brechtm

Ability to disable overloaded function signatures being presented when `autodoc_typehints` is `"signature"` or `"both"`

1

**Is your feature request related to a problem? Please describe.** When the setting above is present and enabled, the build documentation presents multiple entries for ov erloaded function signature: ...

AbstractUmbra

autodoc: Add support for PEP 613 - Explicit Type Alias

2

**Is your feature request related to a problem? Please describe.** PEP 613 introduces a new type to help with static type checking called `TypeAlias`. It's expected to be released in...

jp-larose

**Use Case:** We are generating alternate documents from a "master" document using conditional compiling (.. ifconfig ::). We also have to manage multiple translations out from those "alternate" documents. It...

MacqGit