-
Related to PR #722.
I have a failing test for unknown reasons.
The problem is that the test is not documented. There is not doc string. It is unclear what happens in their. It also seems it is a p…
buhtz updated
10 months ago
-
There are some sphinx documentation minor issues:
```console
+ /usr/bin/python3 setup.py build_sphinx -b man
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
[autosumma…
-
I think the documentation that you have written in https://github.com/marchirschvogel/ambit/blob/master/doc/ambit_doc.pdf is really good, and I think it deserves to be added as a part on an online doc…
-
https://github.com/sphinx-contrib/apidoc
Last commit 5 years ago. We should replace this.
-
### Describe the bug
I'm using NumPy docstring format, thanks to Napoleon extension. In order to be able to document multiple return values from a function (yeah, quite a known problem), I'm using …
-
**Is your feature request related to a problem? Please describe.**
Running `python -m sphinx --help`, I see it's an alias for `sphinx-build`.
It would be cool if this was an entrypoint to other …
-
I am not sure if this is the correct place to post this as I do not know the intricacies of sphinx/myst, but I'm sure you can point me in the right direction.
In jupyter lab, everything looks just …
-
**Describe the solution you'd like**
- [ ] some basic PYTHON_USAGE.md documentation page?
- or browser.fi/python_usage or such
- [ ] The basic examples from README https://github.com/MarketSqua…
-
### Details
Create docs page for this repository with Sphinx
Navigate to the docs/ folder
Initialize Sphinx
sphinx-quickstart
When prompted, you can use the default options for most settings.…
-
From doc building on github actions
```
Run cd docs
cd docs
make html
shell: /usr/bin/bash -e {0}
sphinx-build -E -b html . _build/html
Running Sphinx v5.3.0
Extension error:
Could…