1
0
mirror of https://github.com/kakwa/ldapcherry synced 2024-06-07 19:47:47 +02:00
ldapcherry/docs
kakwa aa7db36efc using demo backend as an example
the demo backend is far simplier than the ldap backend,
so it's more logic to use it as an implementation example
2015-08-09 19:38:23 +02:00
..
assets better css for documentation 2015-07-21 01:08:55 +02:00
docs adding hackish symlink for doc image resources 2015-07-16 21:10:03 +02:00
backend_api.rst using demo backend as an example 2015-08-09 19:38:23 +02:00
backends.rst adding documentation for demo 2015-08-09 19:33:54 +02:00
changelog.rst ChangeLog at root of repo + log of current devs. 2015-08-01 13:43:32 +02:00
conf.py more debug in doc configuration 2015-07-20 00:01:18 +02:00
deploy.rst adding documentation for custom js 2015-08-09 10:45:03 +02:00
forkme.rst adding fork me banner 2015-07-21 08:54:28 +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 mention the goodies directory 2015-07-21 00:33:05 +02:00
index.rst adding confirqtion for backends 2015-08-05 00:20:47 +02:00
install.rst fix install documentation 2015-07-20 01:48:37 +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
screenshots.rst extracting screenshots in a separate page 2015-07-31 18:50:34 +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