mirror of
https://github.com/snipe/snipe-it.git
synced 2024-11-14 01:24:06 -08:00
821 B
821 B
Documentation
Project documentation is built using Sphinx docs, which uses ReST for markup. This allows the docs to cover a vast amount of topics without using a thousand-line README file.
Sphinx docs is pip-installable via pip install sphinx
. Once installed, open a command line in the docs folder and run the following commands:
$ sudo pip install -r requirements.txt
This will install the requirements needed for the generating the docs. Afterwards you can run:
$ make html
The docs will be generated, the output files will be placed in the _build/html/
directory, and can be browsed (locally) with any browser.
The docs can also be found online at http://bootstrap-datepicker.readthedocs.org/.