Merge pull request #100 from HaToHo/master

New format of documentation.

.gitignore

@@ -173,3 +173,7 @@ example/sp-repoze/sp_conf.py
 example/idp2/sp_test.xml
 
 example/sp-repoze/idp_test.xml
+
+example/sp-repoze/sp_conf_example.py
+
+example/idp2/idp_conf_example.py

doc/client.rst

@@ -1,18 +0,0 @@
-.. _client:
-
-***********************************************
-Classes representing Service Provider instances
-***********************************************
-
-:Author: Roland Hedberg
-:Version: |version|
-
-.. module:: Client
-   :synopsis: Classes representing Service Provider instances.
-
-Module
-==========
-
-.. automodule:: saml2.client
-   :members: 
-

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
@@ -22,7 +23,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.doctest', 'sphinx.ext.coverage']
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.coverage', 'sphinx.ext.viewcode',]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -91,7 +92,26 @@ pygments_style = 'sphinx'
 
 # The theme to use for HTML and HTML Help pages.  Major themes that come with
 # Sphinx are currently 'default' and 'sphinxdoc'.
-html_theme = 'default'
+#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 implementation',
+   'github_button': False,
+   'github_user': 'rohe',
+   'github_repo': 'pysaml2',
+   'github_banner': False,
+
+}
 
 # 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

doc/examples/index.rst

@@ -14,10 +14,3 @@ Contents:
    sp
    idp
    
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-

doc/index.rst

@@ -5,12 +5,16 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to the documentation of pysaml2!
+pysaml2
 ========================================
 
 :Release: |release|
 :Date: |today|
 
+PySAML2 is a pure python implementation of SAML2. It contains all necessary pieces for building a SAML2 service
+provider or an identity provider. The distribution contains examples of both. Originally written to work in a WSGI
+environment there are extensions that allow you to use it with other frameworks.
+
 Contents:
 
 .. toctree::
@@ -18,8 +22,11 @@ Contents:
 
    install
    howto/index
-   saml2
    examples/index
+   code/s2repoze
+   code/saml2
+   code/xmldsig
+   code/xmlenc
 
 Indices and tables
 ==================
@@ -28,3 +35,8 @@ Indices and tables
 * :ref:`modindex`
 * :ref:`search`
 
+.. raw:: html
+
+    <a href="https://github.com/rohe/pysaml2" class="github" target="_blank">
+        <img style="position: absolute; top: 0; right: 0; border: 0;" src="_static/ViewmeonGitHub.png" alt="View me on GitHub"  class="github"/>
+    </a>

doc/make.sh

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

doc/saml.rst

@@ -1,18 +0,0 @@
-.. _saml:
-
-******************************************
-Base classes representing Saml2.0 elements
-******************************************
-
-:Author: Roland Hedberg
-:Version: |version|
-
-.. module:: SAML2
-   :synopsis: Base classes representing Saml2.0 elements.
-   
-Module
-==========
-
-.. automodule:: saml2.saml
-   :members: 
-

doc/saml2.rst

@@ -1,29 +0,0 @@
-.. _base:
-
-****************************************
-Base classes representing basic elements
-****************************************
-
-:Author: Roland Hedberg
-:Version: |version|
-
-.. module:: Base
-   :synopsis: Base classes.
-
-.. toctree::
-   :maxdepth: 2
-
-   saml
-   samlp
-   metadata
-   xmldsig
-   xmlenc
-   client
-   server
-   
-Module
-==========
-
-.. automodule:: saml2
-   :members: 
-

doc/samlp.rst

@@ -1,18 +0,0 @@
-.. _samlp:
-
-***************************************************
-Base classes representing Saml2.0 protocol elements
-***************************************************
-
-:Author: Roland Hedberg
-:Version: |version|
-
-.. module:: SAMLP
-   :synopsis: Base classes representing Saml2.0 protocol elements.
-   
-Module
-==========
-
-.. automodule:: saml2.samlp
-   :members: 
-

doc/server.rst

@@ -1,19 +0,0 @@
-.. _server:
-
-***********************************************************************
-Classes representing Identity Provider or Attribute Authority instances
-***********************************************************************
-
-:Author: Roland Hedberg
-:Version: |version|
-
-.. module:: IdPAA
-   :synopsis: Classes representing Identity Provider or Attribute 
-                Authority instances.
-
-Module
-======
-
-.. automodule:: saml2.server
-   :members: 
-

doc/xmldsig.rst

@@ -1,18 +0,0 @@
-.. _xmldsig:
-
-*************************************
-Classes representing xmldsig elements
-*************************************
-
-:Author: Roland Hedberg
-:Version: |version|
-
-.. module:: XmlDsig
-   :synopsis: Classes representing xmldsig elements.
-
-Module
-==========
-
-.. automodule:: xmldsig
-   :members: 
-

doc/xmlenc.rst

@@ -1,22 +0,0 @@
-.. _xmlenc:
-
-*************************************
-Classes representing xmlenc elements
-*************************************
-
-#:mod: 'XmlEnc' -- xmlenc
-
-=====================================================
-
-:Author: Roland Hedberg
-:Version: |version|
-
-.. module:: XmlEnc
-   :synopsis: Classes representing xmlenc elements.
-
-Module
-==========
-
-.. automodule:: xmlenc
-   :members: 
-