-
What is known as a field list doesn't render nicely. Perhaps the issue has been overlooked because field lists are normally for API documentation.
Rendered directly in the main section, it looks li…
-
_Originally posted by @gerrymanoim in https://github.com/gerrymanoim/exchange_calendars/issues/61#issuecomment-885372008_
I'd add
- [ ] Real documentation
My preference is probably some mar…
-
```
What steps will reproduce the problem?
1. run e.g. `release.sh branches/2.1 2.1.0rc1`
What is the expected output? What do you see instead?
everything works up to the point where it should uploa…
-
```
What steps will reproduce the problem?
1. run e.g. `release.sh branches/2.1 2.1.0rc1`
What is the expected output? What do you see instead?
everything works up to the point where it should uploa…
-
Sphinx has many custom directives and roles, for highlighting and cross referencing docs.
The restructuredtext_lint doesn't support any out of the box (it shouldn't)
So, there are lots of issues…
-
### Describe the bug
When generating documentation for class with decorators that override __new__, documentation for the class is missing and sphinx warns that maximum recursion depth was exceeded i…
-
Currently, we have no documentation of the existing functions, but they are demonstrated in the examples at `example/lib/main.dart` under the runAFunction method.
Write base level documentation for…
-
need some guide or reference for the user so they can understand how to use the goals and lending feature
-
**Is your feature request related to a problem? Please describe.**
With [sphinx-apidoc](https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html), it's possible to generate a `conf.py` with the …
-
## Description
Other modules, such as https://github.com/agronholm/sphinx-autodoc-typehints, also extend the options of the sphinx documentation. However, they do not use decorators in the code. Inst…