-
Give an overview of the functionality present in toil-lib. Document the requirements for individual pieces, most prominently Docker.
-
I've been looking for a way to add instructions to the build process aside from solely calling `sphinx-build`. As a C++ developer, my use case for sphinx involves using `doxygen`/`breathe` to generate…
-
Texts from Sphinx themes are not available for translation and are shown in English in every translated Sphinx doc. This impacts the texts `Documentation »` from upper navigation bar, and `On this pag…
-
https://rest-sphinx-memo.readthedocs.io/en/latest/index.html
-
I am following this tutorial (https://panel.holoviz.org/how_to/wasm/sphinx.html), but unfortunately did not manage to build the documentation which show's the panel in sphix due to an import error bas…
-
The little bit of help in the README isn't great. We should get the package marked up and rendering with Sphinx, and host it on readthedocs.io, either directly on the site as a stand-alone, or within …
-
The scripts that are available in this repository are quite straight forward. On the other hand, if these scripts are going to be used repetitively it is important to have them documented better!
-
Examples: https://www.sphinx-doc.org/en/master/examples.html
https://docs.python.org/3/index.html
-
Advice for new projects on setting up high-quality documentation. It should cover:
* Setting up Sphinx (maybe also something simpler?)
* Documentation best practices
* qiskit-sphinx-theme
We c…
-
I wrote all my Docstrings, and I tried to use the Sphinx Quickstart tool in Pycharm to generate documentation. I think I followed the procedure on how to generate documentation but it's not working, a…
HL232 updated
5 years ago