Updated the doc to alabaster and created a make.sh

This commit is contained in:
daniel evertsson
2014-04-01 10:58:09 +02:00
parent 06aa2dda99
commit e69b94ec36
3 changed files with 27 additions and 2 deletions

View File

@@ -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

View File

@@ -18,6 +18,7 @@ Contents:
howto
install
saml2test
Indices and tables
==================

5
doc/make.sh Executable file
View File

@@ -0,0 +1,5 @@
#!/bin/sh
rm -f saml2test*
sphinx-apidoc -F -o ../doc/ ../src/saml2test
make clean
make html