-
I wanted to try your sphinx-c-autodoc to document one of my zephyr projects. The code is entirely written in c. It works quite well at least for the configuration and building. The rendered code docum…
-
Currently, our various classes are described in the documentation via explicit `.. class` `.. method` directives. We should move to autodoc, and move these docstrings inline.
This will reduce the d…
-
**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 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…
-
## 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…
-
Similar to sphinx-autodoc
- [Developing extensions for Sphinx](http://www.sphinx-doc.org/en/stable/extdev/)
- [Autodoc Documentation](http://www.sphinx-doc.org/en/stable/ext/autodoc.html#module-sp…
-
### Problem
This is a spin-off of defect https://github.com/sphinx-doc/sphinx/issues/7972
The styling of types for properties looks different than for types of return values:
https://github.c…
-
The AiiDA sphinx extension previously supported just using ``.. automodule::``, by hooking into ``sphinx.ext.autodoc``. This no longer works, as can be seen by this part of the test / demo documentati…
-
When converting rST projects to use MyST, directives from sphinx.ext.autodoc's such as `automodule` can cause issues.
The sphinx extension sphinx.ext.autodoc provides directives (`automodule`, `aut…
-
When Sphinx autodoc / autoapi creates domentation, the table of contents should group the content by classes, attributes etc. For an unknown reason, when a module contains both classes and attributes,…