| commit | author | age | ||
| 83c3f6 | 1 | Documentation |
| SP | 2 | ============= |
| 3 | ||
| 4 | Project documentation is built using [Sphinx docs](http://sphinx-doc.org/), which uses [ReST](http://docutils.sourceforge.net/rst.html) for markup. This allows the docs to cover a vast amount of topics without using a thousand-line README file. | |
| 5 | ||
| 6 | Sphinx docs is pip-installable via `pip install sphinx`. Once installed, open a command line in the docs folder and run the following commands: | |
| 7 | ||
| 8 | ```bash | |
| 9 | $ sudo pip install -r requirements.txt | |
| 10 | ``` | |
| 11 | ||
| 12 | This will install the requirements needed for the generating the docs. Afterwards you can run: | |
| 13 | ||
| 14 | ```bash | |
| 15 | $ make html | |
| 16 | ``` | |
| 17 | ||
| 18 | The docs will be generated, the output files will be placed in the `_build/html/` directory, and can be browsed (locally) with any browser. | |
| 19 | ||
| 20 | The docs can also be found online at <http://bootstrap-datepicker.readthedocs.org/>. | |
