-
## Background
One of the challenges in getting started with Sphinx is the `conf.py` file, for a few reasons:
1. It is written in Python, and so it is Python-specific, even if the person writing …
-
What's the preferred way to document object properties?
I see lots of different examples:
http://docs.sylius.org/en/latest/book/channels.html Does it by a list. Name of property is in bold followed …
-
## Issue description
Hi, users are unable to run _**agpytesting**_ due to dependency conflict with _**pillow**_ package.
As shown in the full dependency graph of **agpytesting**, **agpytesting** re…
-
consider the folder structure of https://github.com/sphinx-contrib/matlabdomain/tree/master/tests/test_data
I would have expected that:
```
.. automodule:: test_data
```
would generate the docu…
-
Hello, in Debian we already upgraded sphinx-autodoc-typehints to 2.3.0 and cherry-picking https://github.com/RDFLib/rdflib/pull/2852 isn't enough to fix the build.
(we haven't upgraded to sphinx-au…
-
以我一个新手的理解，python中一个项目开发涉及的内容主要有：1）项目结构搭建；2）自动化doc文档生成；3）命令行工具制作（视情况而定）；4）打包发布，或直接部署。
-
I tried to build the docker image today using the following command from `README`
```
docker build -t updoc .
```
and got an error
```
Installed /opt/conda/lib/python3.7/site-packages/jmespath-0…
-
Subject: `pytest-bdd` incompatibility with `sphinxcontrib-napoleon`
### Problem
It seems that Sphinxcontrib-napoleon is not able to generate the documentation for the functions decorated with the …
-
Hi,
I made (more than one month ago) a little patch (against the 24ad0c778dad commit) to implement a new commandline option of apidoc.py:
-G (--graph) will add the needed directives in conf.py and *.…
-
**Describe the bug**
See screenshot below, the labels are not rendering correctly
**Screenshots**
**System**
- OS:
- [x] GNU/Linux
- [ ] macOS
- Environment (`conda list`):
…