Closed GMishx closed 5 years ago
@GMishx I think we should not add .rst files to the repository. If anyone wants to contribute to the docs, he/ she can submit the patch generated according to "How to generate Sphinx documentation" which can be reviewed by the admin/ maintainers.
I added the .rst
files to add the :private-members:
to every module. So if anyone creates documentation, they can get the private functions in the docs.
I could not find any other way to add it other than adding it manually to every file.
Can be done programmatically though.
How to generate the documentation using setuptools
Build atarashi (or install sphinx using
pip install sphinx m2r
)Refresh source
.rst
files:private-members:
under your new.. automodule::
.Generate the docs
python3 setup.py build_sphinx --help
for more.