-
Use sphinx to generate the restructured text documentation.
-
We should be enforcing warning-less sphinx build. Practice shows rST files tend to fall behind with code changes.
Steps:
- [ ] fix remaining errors and warnings in `sphinx_docs` target after lat…
-
**What happened**:
Sphinx 5.x fails on generate documentaion because problematic `sphinx_design` extension
**What you expected to happen**:
It shoud be possible to generate documentation with lat…
-
I tried to start (again) the documentation of natlinkcore, by following the instructions on natlinkcore.readthedocs.io.
However, after `pip install -r requirements.txt`, The script `make.bat html`…
-
Sphinx supports doc comments in the form of `#:`.
This is also part of the expected and documented syntax for the google and numpy formats, supported in the sphinx implementation but not here.
T…
-
Too often, documentation is not enough to understand how some API functions are working.
For example, Colour-Science Python library usually provides a link to a source code where possible to check ho…
-
The refactoring of the project from a single Python file into a full module broke sphinx -
documentation content is partial, despite almost all classes and functions having
a good enough docstring …
-
Add automated documentation build with successful deployment
-
Specifically, it would be nice if we had an online manual.
-
Documentation is currently written for Sphinx.
Explore converting to Markdown or pure HTML for simpler handling on Windows.