security-and-privacy/ldapcherry

mirror of https://github.com/kakwa/ldapcherry synced 2024-06-26 13:42:56 +02:00

History

kakwa b25c90dff4 removing full configuration and goodies to deploy doc		2015-07-20 01:45:04 +02:00
..
assets	changing doc css (better title color)	2015-07-19 19:24:33 +02:00
docs	adding hackish symlink for doc image resources	2015-07-16 21:10:03 +02:00
backend_api.rst	fixing title level in backend API documentation	2015-07-20 01:32:52 +02:00
changelog.rst	initial commit	2014-06-02 23:10:19 +02:00
conf.py	more debug in doc configuration	2015-07-20 00:01:18 +02:00
deploy.rst	removing full configuration and goodies to deploy doc	2015-07-20 01:45:04 +02:00
full_configuration.rst	adding a page in the documentation for the full configuration	2015-07-20 01:44:00 +02:00
goodies.rst	adding a page in the docuementation for the goodies	2015-07-20 01:44:26 +02:00
index.rst	adding new pages in index table	2015-07-20 01:44:48 +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
ppolicy_api.rst	small cleaning in ppolicy_api.rst	2015-07-20 01:30:12 +02:00
README.rst	initial commit	2014-06-02 23:10:19 +02:00

README.rst

Build the LdapCherry docs/website:

The Ldapcherry documentation/website is built using Sphinx.

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