prokuranepal / inventory_app

https://prokuranepal.github.io/inventory_app/
GNU Affero General Public License v3.0
8 stars 14 forks source link

Code Documentation #43

Open sazan10 opened 4 years ago

sazan10 commented 4 years ago

Documentation needed The project has the code documentation hosted on link but it has been started just recently and needs more. For starters documentation can be started from:

Documentation needs the following basic details:

Note: You will need to install sphinx-js and to generate doc simply run "make html" inside the docscripts directory. The index.html file inside docs directory has been configured for github pages.

Documentation tool used: Sphinx-js . It pulls the JSDoc-formatted documentation from codes for auto documentation. For more information on sphinx-js refer link