Coverage for pycommons / dev / doc / __init__.py: 100%

1""" 

2Tools for making the documentation. 

3 

4In all of my projects, the documentation is generated in the same way from 

5the same data. Therefore, this process is unified here, which makes it easier 

6to apply changes throughout all projects. 

7 

8The general idea is that we take all the information from the `setup.cfg`, 

9`README.md`, and `version.py` files and use it to automatically fill the 

10parameters of sphinx and to construct `index.rst` and a variant of `README.md` 

11that the myst parser used by sphinx can properly render. 

12"""