search

aboutcode-org / vulnerablecode

A free and open vulnerabilities database and the packages they impact. And the tools to aggregate and correlate these vulnerabilities. Sponsored by NLnet https://nlnet.nl/project/vulnerabilitydatabase/ for https://www.aboutcode.org/ Chat at https://gitter.im/aboutcode-org/vulnerablecode Docs at https://vulnerablecode.readthedocs.org/
https://public.vulnerablecode.io
Apache License 2.0
523 stars 193 forks source link

Use sphinx autodoc #625

Open Hritik14 opened 2 years ago

Hritik14 commented 2 years ago

We have significant amount of documentation in docstrings. It would be better to get those on RTD.

How: https://documentation.help/Sphinx/autodoc.html#module-sphinx.ext.autodoc

Hritik14 commented 2 years ago

Also: https://docs.djangoproject.com/en/dev/internals/contributing/writing-documentation/