-
Information is lacking on how the doc-generation works and how to edit the docs, so intend to add this information to the 'Developer' section of the documentation and/or a 'how-to' file in the home di…
-
The docs build takes forever to run. rstcheck is a fast way of checking if the docs are actually written in the correct format to be compileable by sphinx.
cc @svekars @brycebortree @ezyang
-
**Describe the bug**
Static methods lose their first parameter in signature if they are also name mangled, i.e. __begins_like_this().
Similar to #4769 and #5032.
**To Reproduce**
Please download…
-
When embedding an *.ipynb file through nbsphinx, I receive an ImportError.
I have tried different setups now, also Python3.6.13 as alternative version, but eventually I always land with the same i…
-
It looks like [the upstream repo]( https://github.com/sphinx-contrib/napoleon ) has been archived. Also it was long ago upstreamed into Sphinx ( https://github.com/sphinx-doc/sphinx/commit/a00a096069f…
-
**Is your feature request related to a problem? Please describe.**
The current implementation of the multiprocessing architecture has some problems, especially with bigger projects (500 - 25.000 page…
-
following #314
There are three stages of doc generation, each currently done manually.
1. `autogenerate-bloqs-notebooks.py` takes a list of `Bloq` objects and writes stub notebooks and refreshe…
-
We have an older section that encourages ReST, though we wanted to use markdown; only document headlines (the first one on top) really need to be written in ReST now as far as I understand the Sphinx …
-
Just to catch your options:
Would the documentation benefit from having a section, mapping the functionality against the typical modelling steps outlined in:
https://pvpmc.sandia.gov/modeling-steps/
…
-
### Problem
index.rst changes should force rebuilding every html file since the short table of contents is included in every html, but the incremental `sphinx-build` doesn't check this dependency. (…