-
Used to use epidoc for code documentation, but generating html docs broke some time ago, move to spinx instead - see http://www.sphinx-doc.org
- Setup meta data needed to compile API docs
- Update…
-
Raw, almost unedited notes from our unconference session on Sphinx. Suggestion by @plaindocs - what do you think would be the best place to put these?
- what do you love about sphinx
- code int…
-
It looks like our documentation dependencies in combination currently force installation of a quite old version of sphinx (5.x, current version is 7.x) , and also our theme used (sphinx-rtd-theme==0.5…
sk1p updated
3 months ago
-
I noticed that there's no RTD CI check that runs on every PR.
I realize there is a check to ensure docs build successfully, but that only checks local builds. Whereas I've found the RTD check useful …
-
I am using numpydoc style for my documentation. Everything seems okay, except for a few warnings when running ```sphinx-build -M simplepdf docs/source/ docs/build/ -a```:
Sphinx output
```
Ru…
-
**Problem description**
I have run into a situation that seems not to be handled by sphinx globbing. I have two toctrees that use globbing to define their contents. The intent is two sets of non-ov…
-
Ideally, we want simple, topic specific user documentation guides in PDF format, so that we can refer user to these for their convenience.
**Sphinx has the option for multiple PDFs, but does Read…
-
Yeah .. looks like at least sphinx/index.rst is missing
```console
+ /usr/bin/sphinx-build -n -T -b man sphinx build/sphinx/man
Running Sphinx v4.5.0
making output directory... done
myst v0.17.2:…
-
To avoid breakage and unexpected problems when a release is made, we could add a CI job that builds the docs pages for a list of selected projects and verifies that the output is as expected. Ideally,…
-
### Describe the bug
It looks like some HTML `meta` tags are being duplicated in the HTML builder's output, at least when using the Sphinx basic theme.
For example, in the [`jinja` v3.1 documentat…