-
nsbgn updated
2 years ago
-
I am generating API documentation using autoapi.extension in Sphinx. It is a large repo, and not all of the doc strings are well formatted and this generates a lot of sphinx docutils warnings. However…
-
GitHub actions for:
- [ ] Running the test suite.
- [ ] Releasing to pypi on tags.
- [ ] Building the documentation (upstream from that: add sphinx documentation)
-
### Link to source code that is involved in this issue
https://salsa.debian.org/python-team/packages/pydata-sphinx-theme
### Reproducer
Hello!
I would like some help. I'm a maintainer on the Deb…
-
### Version
Development
### What is affected by the bug?
The docstrings will not render properly on RTD using Sphinx.
### When does the bug occur?
When building the docs.
### How do …
-
Now that we have an API, it makes sense to get more documentation than the single README file (which is already quite heavy).
It might be a good time to use read the docs.
-
As suggested by @drphilmarshall [here](https://github.com/DarkEnergyScienceCollaboration/Twinkles/issues/251)!
@heather999 I believe we already have sphinx docstrings in some of our code in the Mon…
-
The dripline-python package is divided between (1) C++ code with python bindings and (2) pure python code built on top of the bound code. From a user perspective, this appears all as one `dripline` p…
-
To be added
-
In kw, we document our code by using Sphinx syntax (in general). Additionally, Bash and Python share the same documentation style (`#`). In this sense, can we find a way to generate code documentation…