QueryJane | Code documentation - App and corporative modules

Repository
https://github.com/augustakingfoundation/queryjane_app/

QueryJane is a web application developed with Django that allows to connect with companies and experts in different sectors of the cannabis industry. Beta version is available here.

Details

In my last update about the project documentation, I have activated the Sphinx autodoc module. In this opportunity, by using this module, I have added the python code documentation for the app/ and for the corporative/ applications.

I have integrated a new theme for the html documentation. It looks much better and it let me fix the bug (broken links) that there was with the index and with the Python index modules.

Documenting the project allowed me to review the structure of the code again, and for this reason, I am taking advantage to do a big code recovery too.

Components

New documentation is about Python files included into the app and the corporative applications. Views, permissions, forms, models, tasks and form field validators defined in Python code have been documented in this update.

Files documented in the app application.

app/
-----> views.py
-----> tasks.py
-----> validators.py

Files documented in the corporative application.

corporative/
-----> forms.py
-----> models.py
-----> permissions.py
-----> tasks.py
-----> views.py

Difference

Now the Python code in the application it's almost fully documented. There are two pending applications yet. Interested people can understand in a easiest way the functionalities defined into the app/ and the corporative/ applications. Also, now the indexes table is available, and a new better theme has been integrated.

Links

Docs homepage
App application
Corporative application
Index
Module index

GitHub Proof of Authorship

• GitHub Account: https://github.com/aaquirogal
• Pull Request: 118, 119, 122.