Project Ideas Create docs automatically from scancode data

Create docs automatically from scancode data

Goals

The goal of this project is to create a documentation section automatically for all scancode data attributes.

There is currently no single file in the codebase (like Django models), but there are several of them present throughout the codebase.

• ./src/scancode/api.py - general fields
• ./src/licensedcode/models.py - License fields
• ./src/packagedcode/models.py - Package fields
• codebase_attribute and resource_attribute for each scancode plugin

The documentation has to be added directly to the code, which is to be collected and parsed in some manner connecting it to RTD doc generation.

1. A first step should be to investigate whether there are existing automated documentation tools for Python that would help us get started.

2. Use attrs classes all the way for models and define/design a simple way to add a docstring of sorts to each model and attribute.

3. Make a list of all data attributes to document (that appears in the scancode result) and implement the above for all of them.

4. Have/create a way to get that integrated into sphinx, possibly with custom extensions.

5. Integrate with existing doc generation, and make it a part of doc publication, with docs to help contributors keep the data documentation updated.

It should be hosted as a section in the scancode RTD documentation - scancode-toolkit.readthedocs.io/en/latest/scancode-data/

You will work closely with a mentor to add the documentation and implement the automatic documentation creation process.

---

Level

• Intermediate

Tech

• Python
• Sphinx
• ReadTheDocs

URLS

• https://github.com/nexB/scancode-toolkit/issues/2008
• https://github.com/nexB/scancode-toolkit/issues/2425

Mentors

• @AyanSinhaMahapatra https://github.com/AyanSinhaMahapatra
• @majurg https://github.com/majurg