-
It looks like autodoc is resolving type hints like `requests.Response` to their internal definition, e.g. `requests.models.Response`. This means the intersphinx references to the [Requests API docs](h…
-
when I run
```
sphinx-apidoc -f -o docs robotic_skin
sphinx-autobuild docs docs/_build/html
```
I get these errors.
These are due to the use of other docstring style.
```
WARNING: autodoc:…
-
Consider the apidocs, using sphinx-autodoc-typehints, of
```
def f1(x):
"""
A function.
:param int x: The x.
"""
def f2(x: int):
"""
A function.
:param x: T…
-
https://www.sphinx-doc.org/en/master/man/sphinx-apidoc.html
Also use the template features.
-
## 📚 Documentation
we currently use `sphinx-apidoc` to autogenerate docs, but it leaves a little to be desired in the way of organization... but it also doesn't provide a ton of options (beyond tem…
-
1. Documentation
- [x] deployed by ReadTheDocs
- [x] docstrings for all functions should be rendered using the napolean Sphinx extnesion
- [x] documentation include a demonstration of how to use ea…
-
We're encountering an issue in our CircleCI builds:
```
# github.com:22 SSH-2.0-babeld-e37038b1
Cloning into 'sceptre.github.io'...
Warning: Permanently added the RSA host key for IP address '14…
-
**Checklist prior to opening an issue**
- [x] I have followed fully the installation steps laid out in the documentation site.
- [x] I have restarted jupyterlab.
- [x] I have read the FAQ section i…
-
```console
+ /usr/bin/python3 setup.py build_sphinx -b man
running build_sphinx
Running Sphinx v4.0.2
making output directory... done
Creating file /home/tkloczko/rpmbuild/BUILD/rdflib-5.0.0/docs…
-
### Describe the bug
Hi,
We have a fairly large project with the following folder structure:
- docs
- package
- tests
- ui
- \_\_init__.py
- resources
- gui.qrc
- icons
…