Name Last Update
..
_screenshots Loading commit data...
_static/screenshots Loading commit data...
Makefile Loading commit data...
README.md Loading commit data...
conf.py Loading commit data...
events.rst Loading commit data...
i18n.rst Loading commit data...
index.rst Loading commit data...
keyboard.rst Loading commit data...
make.bat Loading commit data...
markup.rst Loading commit data...
methods.rst Loading commit data...
options.rst Loading commit data...
requirements.txt Loading commit data...

README.md

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