snipe-it/bower_components/bootstrap-datepicker/docs
2017-01-11 03:05:06 -08:00
..
_screenshots Bower components 2017-01-11 03:05:06 -08:00
_static/screenshots Bower components 2017-01-11 03:05:06 -08:00
conf.py Bower components 2017-01-11 03:05:06 -08:00
events.rst Bower components 2017-01-11 03:05:06 -08:00
i18n.rst Bower components 2017-01-11 03:05:06 -08:00
index.rst Bower components 2017-01-11 03:05:06 -08:00
keyboard.rst Bower components 2017-01-11 03:05:06 -08:00
make.bat Bower components 2017-01-11 03:05:06 -08:00
Makefile Bower components 2017-01-11 03:05:06 -08:00
markup.rst Bower components 2017-01-11 03:05:06 -08:00
methods.rst Bower components 2017-01-11 03:05:06 -08:00
options.rst Bower components 2017-01-11 03:05:06 -08:00
README.md Bower components 2017-01-11 03:05:06 -08:00
requirements.txt Bower components 2017-01-11 03:05:06 -08:00

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/.