Merge pull request #85 from kevgliss/documentation

Documentation
This commit is contained in:
kevgliss 2015-09-19 09:48:25 -07:00
commit 6411bd56e9
2 changed files with 22 additions and 20 deletions

View File

@ -568,24 +568,6 @@ All commands default to `~/.lemur/lemur.conf.py` if a configuration is not speci
lemur db upgrade lemur db upgrade
.. data:: create_user
Creates new users within Lemur.
::
lemur create_user -u jim -e jim@example.com
.. data:: create_role
Creates new roles within Lemur.
::
lemur create_role -n example -d "a new role"
.. data:: check_revoked .. data:: check_revoked
Traverses every certificate that Lemur is aware of and attempts to understand it's validity. Traverses every certificate that Lemur is aware of and attempts to understand it's validity.
@ -610,6 +592,26 @@ All commands default to `~/.lemur/lemur.conf.py` if a configuration is not speci
lemur sync -list lemur sync -list
Sub-commands
------------
Lemur includes several sub-commands for interacting with Lemur such as created new users, creating new roles and even
issuing certificates.
The best way to discovery these commands is by using the built in help pages
::
lemur --help
and to get help on sub-commands
::
lemur certificates --help
Identity and Access Management Identity and Access Management
============================== ==============================

View File

@ -57,7 +57,7 @@ copyright = u'2015, Netflix Inc.'
# The short X.Y version. # The short X.Y version.
version = '0.1' version = '0.1'
# The full version, including alpha/beta/rc tags. # The full version, including alpha/beta/rc tags.
release = '0.1.1' release = '0.1.3'
# The language for content autogenerated by Sphinx. Refer to documentation # The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages. # for a list of supported languages.
@ -102,7 +102,7 @@ pygments_style = 'sphinx'
# The theme to use for HTML and HTML Help pages. See the documentation for # The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes. # a list of builtin themes.
html_theme = 'alabaster' html_theme = 'default'
# Theme options are theme-specific and customize the look and feel of a theme # Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the # further. For a list of options available for each theme, see the