monmon a721dfe38c navbar fix | 5 years ago | |
---|---|---|
.. | ||
_screenshots | 5 years ago | |
_static | 5 years ago | |
Makefile | 5 years ago | |
README.md | 5 years ago | |
conf.py | 5 years ago | |
events.rst | 5 years ago | |
i18n.rst | 5 years ago | |
index.rst | 5 years ago | |
keyboard.rst | 5 years ago | |
make.bat | 5 years ago | |
markup.rst | 5 years ago | |
methods.rst | 5 years ago | |
options.rst | 5 years ago | |
requirements.txt | 5 years ago |
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/.