sphinx

sphinx copied to clipboard

Request: C++ namespace as an entity

3

**Is your feature request related to a problem? Please describe.** Currently, `breathe` uses `cpp:type` to render namespaces. This means that opening the same namespace in multiple files results in a...

ZedThree

`:undoc-members:` option doesn't work for instance attributes

1

### Describe the bug The `:undoc-members:` option does not include instance attributes without docstrings when used with the `.. autoclass::` directive. ### How to Reproduce **example.py** ```py class Example: """A...

electric-coder

toctree globbing uses lexicographical instead of natural sorting

3

When using a toctree with the `glob` option, the filenames in the list are sorted using [Python's `sorted()`](https://github.com/sphinx-doc/sphinx/blob/master/sphinx/directives/other.py#L78), which does lexicographical sorting. An example result would be: - file10.rst -...

jessetan

Re-add tox integration

2

### Feature or Bugfix Refactoring ### Purpose Re-add a tox environment for linters. This environment uses the 'lint' extras and runs the same commands as the GitHub Workflows. A note...

stephenfin

Add CVE and CWE roles

2

Subject: ### Feature or Bugfix - Feature ### Purpose - Add a `cve` role to turn ``` :cve:`2020-10735` ``` into https://cve.mitre.org/cgi-bin/cvename.cgi?name=CVE-2020-10735 - Add a `cwe` role to turn ``` :cwe:`787`...

hugovk

Allow Gettext message extraction to be skipped on selected documents using a `:notranslate:` metadata field. ### Feature or Bugfix Feature ### Relates Fixes #11787

jeanas

### Describe the bug Parsing C++ code that includes [aggregate initialization w/ designated initializers](https://en.cppreference.com/w/cpp/language/aggregate_initialization#Designated_initializers) fails. Example error: ``` E sphinx.util.cfamily.DefinitionError: Invalid C++ declaration: Expected identifier in nested name. [error at...

drewrisinger

"Invalid C++ declaration" with C++ lambda expression

1

### Describe the bug When building the Apache Arrow docs, we get the following warning: ``` /home/antoine/arrow/dev/docs/source/cpp/api/dataset.rst:62: WARNING: Parsing of expression failed. Using fallback parser. Error was: Error in postfix...

pitrou

**Is your feature request related to a problem? Please describe.** For classes that have a `__class_getitem__()` method that returns an `Annotated` type, the extra metadata stored on the Annotated object...

dstansby

have backslash be an inline literal word wrap break character in HTML

3

### Describe the bug Similar to this issue for latex: https://github.com/sphinx-doc/sphinx/issues/6000 When I view ``really/long/filepaths`` on mobile, they are not word wrapped, and just keep going off the side of...

jbaylies