diff options
author | daniel evertsson <daniel.evertsson@umu.se> | 2014-04-01 10:58:09 +0200 |
---|---|---|
committer | daniel evertsson <daniel.evertsson@umu.se> | 2014-04-01 10:58:09 +0200 |
commit | e69b94ec367662151f919e8bf18eeafb762e81b7 (patch) | |
tree | d205f9e0199c578a567524489677d892cac2a012 /doc | |
parent | 06aa2dda996b707fde4823264c54f67840d7c53f (diff) | |
download | pysaml2-e69b94ec367662151f919e8bf18eeafb762e81b7.tar.gz |
Updated the doc to alabaster and created a make.sh
Diffstat (limited to 'doc')
-rw-r--r-- | doc/conf.py | 23 | ||||
-rw-r--r-- | doc/index.rst | 1 | ||||
-rwxr-xr-x | doc/make.sh | 5 |
3 files changed, 27 insertions, 2 deletions
diff --git a/doc/conf.py b/doc/conf.py index f6cefd76..e827ba94 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -12,6 +12,7 @@ # serve to show the default. import sys, os +import alabaster # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -25,7 +26,7 @@ import sys, os # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', 'sphinx.ext.viewcode'] +extensions = ['alabaster', 'sphinx.ext.autodoc', 'sphinx.ext.viewcode'] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -91,7 +92,25 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme_path = [alabaster.get_path()] +html_theme = 'alabaster' +html_sidebars = { + '**': [ + 'about.html', + 'navigation.html', + 'searchbox.html', + 'donate.html', + ] +} + +html_theme_options = { + 'description': 'SAML2 and OpenID Connect', + 'github_button': True, + 'github_user': 'its-dirg', + 'github_repo': 'IdProxy', + 'github_banner': True, + +} # 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 diff --git a/doc/index.rst b/doc/index.rst index 054038af..1feaa0b5 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -18,6 +18,7 @@ Contents: howto install + saml2test Indices and tables ================== diff --git a/doc/make.sh b/doc/make.sh new file mode 100755 index 00000000..8496e1df --- /dev/null +++ b/doc/make.sh @@ -0,0 +1,5 @@ +#!/bin/sh +rm -f saml2test* +sphinx-apidoc -F -o ../doc/ ../src/saml2test +make clean +make html
\ No newline at end of file |