1
0
mirror of https://github.com/kakwa/ldapcherry synced 2024-12-18 10:50:04 +01:00
ldapcherry/docs/README.rst
2014-06-02 23:10:19 +02:00

15 lines
516 B
ReStructuredText

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