aboutsummaryrefslogtreecommitdiffhomepage
path: root/public/bower_components/bootstrap-datepicker/docs/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'public/bower_components/bootstrap-datepicker/docs/README.md')
-rw-r--r--public/bower_components/bootstrap-datepicker/docs/README.md20
1 files changed, 20 insertions, 0 deletions
diff --git a/public/bower_components/bootstrap-datepicker/docs/README.md b/public/bower_components/bootstrap-datepicker/docs/README.md
new file mode 100644
index 0000000..58028f3
--- /dev/null
+++ b/public/bower_components/bootstrap-datepicker/docs/README.md
@@ -0,0 +1,20 @@
+Documentation
+=============
+
+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.
+
+Sphinx docs is pip-installable via `pip install sphinx`. Once installed, open a command line in the docs folder and run the following commands:
+
+```bash
+$ sudo pip install -r requirements.txt
+```
+
+This will install the requirements needed for the generating the docs. Afterwards you can run:
+
+```bash
+$ 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/>.