1
0
mirror of https://github.com/kakwa/ldapcherry synced 2024-05-29 07:08:04 +02:00
ldapcherry/docs
2015-07-06 09:34:07 +02:00
..
assets adding screenshots 2015-07-06 09:34:07 +02:00
changelog.rst initial commit 2014-06-02 23:10:19 +02:00
conf.py remove trailing spaces 2015-07-05 22:48:24 +02:00
deploy.rst initial commit 2014-06-02 23:10:19 +02:00
index.rst initial commit 2014-06-02 23:10:19 +02:00
install.rst initial commit 2014-06-02 23:10:19 +02:00
make.bat initial commit 2014-06-02 23:10:19 +02:00
Makefile initial commit 2014-06-02 23:10:19 +02:00
README.rst initial commit 2014-06-02 23:10:19 +02:00

---------------------------------------
Build the LdapCherry docs/website:
---------------------------------------

The Ldapcherry documentation/website is built using `Sphinx`_.

.. _Sphinx: http://sphinx.pocoo.org/

To build the docs you need to perform the following tasks:

* Install Sphinx (``$ sudo apt-get install python-sphinx``)
* From this ``docs`` directory, run: ``$ make html``
* This will produce HTML documentation in the ``_build/html/`` directory
* Open ``_build/html/index.html`` with your browser