From f513ff9b8595770bd1bb927431a77b95ac3c5cdc Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 15:13:30 +0530 Subject: [PATCH 1/9] Made the index.rst more useful --- .gitignore | 1 + doc/index.rst | 24 ++++++++++++++++-------- 2 files changed, 17 insertions(+), 8 deletions(-) diff --git a/.gitignore b/.gitignore index f6d1058..fe1282a 100644 --- a/.gitignore +++ b/.gitignore @@ -27,6 +27,7 @@ tmp* *egg-info* .coverage *.tmpl +_build/ example/idp3/htdocs/login.mako diff --git a/doc/index.rst b/doc/index.rst index e9447c6..869f237 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -6,15 +6,15 @@ How to use PySAML2 :Release: |release| :Date: |today| -Before you can use Pysaml2, you'll need to get it installed. +Before you can use Pysaml2, you'll need to get it installed. If you have not done it yet, read the :ref:`install` Well, now you have it installed and you want to do something. -And I'm sorry to tell you this; but there isn't really a lot you can do with +And I'm sorry to tell you this; but there isn't really a lot you can do with this code on it's own. -Sure you can send a AuthenticationRequest to an IdentityProvider or a +Sure you can send a AuthenticationRequest to an IdentityProvider or a AttributeQuery to an AttributeAuthority but in order to get what they return you have to sit behind a Web server. Well that is not really true since the AttributeQuery would be over SOAP and you would get the result over the @@ -22,19 +22,27 @@ connection you have to the AttributeAuthority. But anyway, you may get my point. This is middleware stuff ! -PySAML2 is built to fit into a +PySAML2 is built to fit into a `WSGI `_ application -But it can be used in a non-WSGI environment too. +But it can be used in a non-WSGI environment too. So you will find descriptions of both cases here. -The configuration is the same disregarding whether you are using PySAML2 in a +The configuration is the same disregarding whether you are using PySAML2 in a WSGI or non-WSGI environment. +Table of contents +================== + .. toctree:: :maxdepth: 1 - config + install + howto/config + + +* :ref:`genindex` +* :ref:`modindex` +* :ref:`search` - From 72c264011963663c0538c25c84a0699259341535 Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 15:21:36 +0530 Subject: [PATCH 2/9] Include example in index --- doc/index.rst | 2 ++ 1 file changed, 2 insertions(+) diff --git a/doc/index.rst b/doc/index.rst index 869f237..29e9e73 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -39,9 +39,11 @@ Table of contents :maxdepth: 1 install + examples/index howto/config + * :ref:`genindex` * :ref:`modindex` * :ref:`search` From acb43a6e5e0187da153f6d6c3333edeb161016d0 Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 15:25:37 +0530 Subject: [PATCH 3/9] remove contents as it references docs not present --- doc/contents.rst | 16 ---------------- 1 file changed, 16 deletions(-) delete mode 100644 doc/contents.rst diff --git a/doc/contents.rst b/doc/contents.rst deleted file mode 100644 index 39984b5..0000000 --- a/doc/contents.rst +++ /dev/null @@ -1,16 +0,0 @@ -Contents -======== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - -.. toctree:: - :maxdepth: 4 - - code/s2repoze - code/saml2 - code/xmldsig - code/xmlenc - - From 7e76af0017d1958afe5f21d092d5fa2f3bed404d Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 15:27:57 +0530 Subject: [PATCH 4/9] Include all docs in index --- doc/index.rst | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 29e9e73..21e8010 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -36,11 +36,13 @@ Table of contents ================== .. toctree:: - :maxdepth: 1 + :maxdepth: 2 install + metadata examples/index - howto/config + howto/index + sp_test/internal From 6eafa15c6d838e20f55dd4f1332230f61307b332 Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 15:33:34 +0530 Subject: [PATCH 5/9] Remove old readme, to keep one canonical copy --- README | 45 --------------------------------------------- 1 file changed, 45 deletions(-) delete mode 100644 README diff --git a/README b/README deleted file mode 100644 index 61b9615..0000000 --- a/README +++ /dev/null @@ -1,45 +0,0 @@ -README for PySAML2 -================== - -Dependencies ------------- -PySAML2 should be compatible with any python >= 2.6 not 3.X yet. - -Install -------- -You will need xmlsec1 to be able to sign/verify, encrypt/decrypt. -You can find xmlsec1 here: - - http://www.aleksey.com/xmlsec/ - -Apart from that a normal - - python setup.py install - -will install the package. - -Documentation -------------- -Look in the doc/ subdirectory. - -Comments, support, bug reports ------------------------------- - -Project page on : - -https://github.com/rohe/pysaml2 - -Use the Pysaml2@uma.es mailing list. Bug reports can either be emailed -to this mailing list of added to the github repository -https://github.com/rohe/pysaml2. - -You can subscribe to this mailing list at -http://delfos.sci.uma.es/mailman/listinfo/pysaml2 - -Archives are available at -http://delfos.sci.uma.es/mailman/private/pysaml2/ - -Contributors ------------- -* Roland Hedberg: main author / maintainer -* Lorenzo Gil Sanchez: Django integration From 4954f0696f18c564d115d3f309e5554d293c14ee Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 15:41:18 +0530 Subject: [PATCH 6/9] Remove metadata.rst for now as sphinx is unable to autodoc --- doc/index.rst | 1 - doc/metadata.rst | 18 ------------------ 2 files changed, 19 deletions(-) delete mode 100644 doc/metadata.rst diff --git a/doc/index.rst b/doc/index.rst index 21e8010..86319eb 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -39,7 +39,6 @@ Table of contents :maxdepth: 2 install - metadata examples/index howto/index sp_test/internal diff --git a/doc/metadata.rst b/doc/metadata.rst deleted file mode 100644 index 1c9d48b..0000000 --- a/doc/metadata.rst +++ /dev/null @@ -1,18 +0,0 @@ -.. _metadata: - -*************************************************** -Base classes representing Saml2.0 MetaData elements -*************************************************** - -:Author: Roland Hedberg -:Version: |version| - -.. module:: MetaData - :synopsis: Base classes representing Saml2.0 metadata elements. - -Module -========== - -.. automodule:: saml2.metadata - :members: - From 28b0f9cf85b8b7498e1691146638182835d115d4 Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 15:42:49 +0530 Subject: [PATCH 7/9] change default theme This fixes warning: WARNING: 'default' html theme has been renamed to 'classic'. Please change your html_theme setting either to the new 'alabaster' default theme, or to 'classic' to keep using the old default. --- doc/conf.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/conf.py b/doc/conf.py index 8397b3d..773e3a4 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -91,7 +91,7 @@ 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 = 'alabaster' # 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 From cf63c4d745de7d8cd82f4f4b28b49a545bc68fda Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 15:50:16 +0530 Subject: [PATCH 8/9] Added some introduction --- doc/index.rst | 21 +++++++++++++++++---- 1 file changed, 17 insertions(+), 4 deletions(-) diff --git a/doc/index.rst b/doc/index.rst index 86319eb..4b59629 100644 --- a/doc/index.rst +++ b/doc/index.rst @@ -1,11 +1,24 @@ -.. _howto: +:Release: |release| +:Date: |today| + +About SAML 2.0 +============== + +SAML 2.0 or Security Assertion Markup Language 2.0 is a version of the SAML standard for exchanging authentication and authorization data between security domains. + +About PySAML2 +============= + +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. + How to use PySAML2 =================== -:Release: |release| -:Date: |today| - Before you can use Pysaml2, you'll need to get it installed. If you have not done it yet, read the :ref:`install` From d55bfeebe70102278181de9d6bca8b44deb9a1aa Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 16:12:30 +0530 Subject: [PATCH 9/9] RTD doesn't have alabaster theme so use the RTD theme https://github.com/rtfd/readthedocs.org/issues/1202 --- doc/conf.py | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/doc/conf.py b/doc/conf.py index 773e3a4..3e43897 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -92,6 +92,11 @@ 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 = 'alabaster' +on_rtd = os.environ.get('READTHEDOCS', None) == 'True' + +if on_rtd: # only import and set the theme if we're building docs locally + html_theme = 'sphinx_rtd_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