-
### Describe the bug
When generating our doc, with `make html`, I get this error:
```
dumping search index in English (code: en)... indexer_dumps_unicode
failed
Exception occurred:
File …
-
Not sure whether this issue should be here or in `ploty.py`, since it depends on the solution.
It would be nice to have links to the API doc https://plot.ly/python-api-reference/ in the code blocks…
-
## 📚 Documentation
We currently use [apidoc](https://github.com/sphinx-contrib/apidoc) for our API Docs, which look like this: https://scitools-iris.readthedocs.io/en/latest/generated/api/iris.ht…
-
## Problem
Our API docs generator is out of date. We need to update it.
-
At the moment, it looks like we are storing the API docs in the codebase instead of dynamically generating it. The API reference is stored in https://github.com/enthought/traits/tree/master/docs/sourc…
-
We should generate documentation from the docstrings in our code. The most popular option seems to be [Sphinx](https://www.sphinx-doc.org/en/master/), but there is also [pdoc](https://pdoc3.github.io/…
-
**Is your feature request related to a problem? Please describe.**
I want to automatically and recursively generate documentation for my Python modules, **using Python code in conf.py to customize th…
-
~This is unrelated to the changes here, but~ I'm reviewing the docs and I found the `external_cpp_references` example doesn't work when the parameter data type is explicitly of global scope (`::nlohma…
-
## Details
* Read the Docs project URL: https://readthedocs.org/projects/reuse
* Build URL (if applicable): https://readthedocs.org/projects/reuse/builds/25578647/
* Read the Docs username (if ap…
-
## Is your feature request related to a problem? Please describe.
Firstly, my thanks to the tireless Sphinx crew (this means *you*!) for your dedication to the just cause of exhaustively well-docum…