QueryJane | Created documentation module

Repository
https://github.com/roadhousestudio/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

I have been searching for a way to create a nice documentation for the project, written using Python and the framework web Django. I found Sphinx, an open source project (link to the repository) that allows to create documentation for Python projects.

I was searching for a documentation builder able to offer outputs in html and Sphinx is perfect for this purpose. In this way, I'm able to deploy the documentation in a http domain. And although the initial configuration cost me a good amount of time, once that was solved, starting to use Sphinx was easy.

Components

In this first part of the project documentation, I have added information about the project system prerequisites, the project requirements and the used technologies. I have added too an a guide to setup the application locally using, and some basic steps to manage database backups.

Difference

The project code is poorly documented. Previously I have added some docstrings to some created functions and classes, but it is not enough to be considered like a valid documentation, especially, considering that the project is really big and a guide is needed to be able to understand it clearly. For this reason, I have created the docs module, with the objective of providing an ordered and nice way to understand the project structure. Now, there is a clear way to understand project prerequisites and architecture, and how to setup it locally.

.py files and deploy process to a production environment will be the next topics to be included in this documentation. I will exploit the process of documenting the .py files to review posible code improvements.

Links

Documentation is available in the following url:

http://docs.queryjane.net/index.html

GitHub Proof of Authorship

• https://github.com/augustakingfoundation

• This update includes PRs From 95 to 101