security-and-privacy/ldapcherry
security-and-privacy/ldapcherry
1
0
Fork 0
mirror of https://github.com/kakwa/ldapcherry synced 2024-11-24 10:14:31 +01:00
Code Releases Activity
882a303474
ldapcherry/docs
History
kakwa d831b09293 improve documentation 
* improve documentation for key: True flag in attributes.yml
* improve documentation for the ldap filters and their templating
* improve comment in the .ini file
2019-02-12 23:06:42 +01: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 improve documentation 2019-02-12 23:06:42 +01:00
changelog.rst ChangeLog at root of repo + log of current devs. 2015-08-01 13:43:32 +02:00
conf.py remove duplicated import in docs conf.py 2017-06-12 19:47:43 +02:00
deploy.rst improve documentation 2019-02-12 23:06:42 +01:00
docs_requirements.txt adding mock for readthedoc 2015-11-03 01:28:38 +01:00
external_plugins.rst adding a page referencing external plugins 2015-11-07 10:04:52 +01: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 better documenation 2017-06-09 23:40:23 +02:00
index.rst adding a page referencing external plugins 2015-11-07 10:04:52 +01:00
install.rst remove pip install method 2017-04-06 21:53:58 +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

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