-
It's worth considering to migrate from Sage's custom documentation style to one of the more established/standarized ones such as:
- [pep257](https://www.python.org/dev/peps/pep-0257/)
- [numpy](…
-
### Describe the bug
When building epub with 4.5.0, the follow warning is produced:
```
WARNING: unknown mimetype for _static/RDFlib.ico, ignoring
```
This prevents the `-W` flag from being u…
-
Hi, thanks for all your hard work. Rocket is awesome!
I think it would be an absolute killer feature if route/endpoint API documentation could somehow be generated right from Rocket. For example, i…
-
When rendering documentation using [Sphinx autodoc](http://www.sphinx-doc.org/en/stable/ext/autodoc.html), the `__init__` method is handled in a special way. The way it is handled depends on the value…
-
### Problem
Multiple properties I defined in the docs are all stacking on a single line. I have no idea what could be causing it. Using `|` to force a new line just adds too much space to be reaso…
-
In addition, just now I experimented a bit with https://github.com/tox-dev/sphinx-autodoc-typehints and this could provide the kind of annotation we would like to see:
```py
def vmap_galactic_ecli…
-
Please make sure to not stop the build when encountering unknown fields - ignoring them would be an option.
You could use https://schematic-ipsum.herokuapp.com/ with the core schema from http://jso…
-
Generate Docs with examples
-
The only way of getting undocumented constants defined in the module into the documentation seems to be to explicitly define:
```
.. py:data:: SOMECONST
```
It would be less surprising if :undoc-…
-
I have a project that includes ~12 modules, with the number expected to grow over time. Instead of getting one enormous page that includes documentation for all 12 modules, I'd like to get a table-of…