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.
![Screen Shot 2018-07-15 at 2.48.06 PM.png](https://steemitimages.com/640x0/https://cdn.steemitimages.com/DQmRE1mVtSFeLXkYx5Uaug3TcPEp2ufGxxSx1qBYMWJo5bF/Screen%20Shot%202018-07-15%20at%202.48.06%20PM.png)
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.
Thanks for contributing.
I can see pull request contains the mix of documentation and code commits.
I can see the documentation part can still be improved I think so.
Your contribution has been evaluated according to Utopian policies and guidelines, as well as a predefined set of questions pertaining to the category.
To view those questions and the relevant answers related to your post, click here.
Need help? Write a ticket on https://support.utopian.io/.
Chat with us on Discord.
[utopian-moderator]
Hey @kit.andres
Thanks for contributing on Utopian.
We’re already looking forward to your next contribution!
Want to chat? Join us on Discord https://discord.gg/h52nFrV.
Vote for Utopian Witness!
@kit.andres You have received a 100% upvote from @steemprotector because this post did not use any bidbots and you have not used bidbots in the last 30 days!
Upvoting this comment will help keep this service running.