1
0
mirror of https://github.com/kakwa/ldapcherry synced 2024-06-26 13:42:56 +02:00
ldapcherry/docs
2015-07-19 19:24:33 +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 better backend api documentation 2015-07-18 11:42:13 +02:00
changelog.rst initial commit 2014-06-02 23:10:19 +02:00
conf.py beginning api documentaion for ppolicy and backend 2015-07-17 08:30:32 +02:00
deploy.rst add documentation for attributes.yml 2015-07-19 18:10:50 +02:00
index.rst beginning api documentaion for ppolicy and backend 2015-07-17 08:30:32 +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 beginning api documentaion for ppolicy and backend 2015-07-17 08:30:32 +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.

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