-
How about adding Sphinx documentation?
It's very nice to have multiple linked pages, code examples, references, ...
It's already used by Gammalib / ctools / Astropy / Gammapy / open-astro-data-format…
cdeil updated
8 years ago
-
I'm using `sphinx-docsearch` to provide search results for `pydata-sphinx-theme`-themed documentation. The documentation is hosted on ReadTheDocs, and we're using RTD to host multiple versions of the …
-
A proper documentation would be useful for people interested in using and improving the plugin.
### Contents:
- [ ] Usage / Guide
- [ ] Improved in Code documentation ready for automatic doc gene…
-
SWIG's documentation currently relies on hand-crafted HTML code, supplemented by a few decades-old Python scripts. Writing HTML by hand is cumbersome and provides another obstacle to improving the doc…
-
Should probably document the Python interface, and add some examples? Some simple examples are in the root README.md, but could have some more detailed examples in separate .rst files? Need to figur…
-
What about having a Sphinx documentation? Not "just a README"?
Here are some advantages:
- publish docs on readthedocs.org
- have a shorter README (summary + 1 example + links). Example here: http://d…
-
Currently, there is no documentation included in source code, only the readme.
This relates to #18
Can we implement a basic sphinx documentation for bibsonomy, once the docstrings are added?
-
Addition of sphinx documentation style to pydocstyle config as so:
```toml
[tool.ruff.pydocstyle]
convention = "sphinx"
```
Currently pep257, google, and numpy documentation styles are supp…
-
Hi, thanks for the nice work! I found sphinx-jinja2 very useful when I needed to customise the generated documentation.
Since the generated documentation contains markdown syntax, I try to use myst…
-
nsbgn updated
2 years ago