-
With Sphinx you can use custom directives by including it in your conf.py extensions list (https://bitbucket.org/birkenfeld/sphinx/src/52ee02818d19/doc/conf.py).
You put the custom directives in a mo…
-
We use `sphinx-gallery` for rendering thumbnail galleries in the built docs for the Jupyter notebooks, which are in the `docs/source/examples/` folder. This issue describes tasks to add the example sc…
-
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
-
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…
-
**Component**: docs
**Why this is needed**:
Code-blocks in documentation are not always easy to handle for users, as different prompts may be confusing when deciding which parts of a doc…
-
In https://github.com/numpy/numpydoc/issues/196 it was discussed how numpydoc could better handle type annotations. As `sphinx-autodoc-typehints` already provides a way to pull the type annotations fr…
jrast updated
2 months ago
-
I'm packaging your module as an rpm package so I'm using the typical PEP517 based build, install and test cycle used on building packages from non-root account.
- `python3 -sBm build -w --no-isolatio…
-
texinfo is the native documentation format to emacs. sphinx can output texinfo. we should use that.
CC: stakemorii@gmail.com @hivert
Component: **documentation**
Keywords: **Sphinx**
Author: …
-
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…
-
Sphinx autodoc uses `autodoc_mock_imports` to, well, mock imports.
Trying to mock modules with `MagicMock` causes them to be excluded from the compiled docs, see https://github.com/sphinx-doc/sphi…