-
**Describe the bug**
Incompatibility with `numpy` docstring convention.
> Attributes that are properties and have their own docstrings can be simply listed by name:
https://numpydoc.readthedoc…
-
## Describe the new feature or enhancement
For the documentation of classes in the [API on the Website](https://mne.tools/dev/python_reference.html) it may be easier to navigate if their methods were…
-
## Description
Looks like sphinx fails with call trace on generate `sphinx-packaging` man page.
## Steps to Reproduce
```console
git clone https://github.com/sphinx-toolbox/sphinx-packaging/
cd…
-
**Describe the bug**
The generated html contains
```html
x – hello
Note
bye
```
Notice the outer paragraph that comes with `li`, which contains inner paragraphs, that's invalid in html. I…
-
@pauleveritt suggests the use of [`sphinx-autodoc-typehints`](https://github.com/tox-dev/sphinx-autodoc-typehints/) to auto-document docstrings and typehints. In addition to the nice formatting, the r…
-
### 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
…
-
# Summary
Running `sphinx-multisession` will run `conf.py` two times per branch/tag, so if the code is imported in `conf.py` it will be cached by Python and the calling branch's code will be used f…
-
### Describe the bug
[There is a class called `FrozenSpaceMeta`](https://github.com/janluke/cloup/blob/3899fbe66a5b339ea0bc78d181cbcea343b1bba5/cloup/_util.py#L122-L138) from the [`cloup`](https://…
-
Hi,
I'm using this package for documenting all my [Python packages](https://github.com/Techtonique), especially [this one](https://github.com/Techtonique/teller/tree/master/docs).
It worked ve…
-
Hi,
first of all thanks for this nice Sphinx extension.
I am running `sphinx-autodoc-defaultargs==0.1.2`. We added now a custom `Exception` into our project and use it at the specific places. Be…