fossology / atarashi

Atarashi scans for license statements in open source software, focusing on text statistics. Designed to work stand-alone and with FOSSology.
http://fossology.github.io/atarashi
GNU General Public License v2.0
26 stars 23 forks source link

feat(docs): Create sphinx docs using setuptools #39

Closed GMishx closed 5 years ago

GMishx commented 6 years ago

How to generate the documentation using setuptools

  1. Build atarashi (or install sphinx using pip install sphinx m2r)

    python3 setup.py build
  2. Refresh source .rst files

    sphinx-apidoc -Pe -o ./docs/source/ ./atarashi
  3. Check for new modules files (if any) and add :private-members: under your new .. automodule::.
  4. Generate the docs

    python3 setup.py build_sphinx
  5. Check python3 setup.py build_sphinx --help for more.
amanjain97 commented 6 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.

GMishx commented 6 years ago

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.