From f513ff9b8595770bd1bb927431a77b95ac3c5cdc Mon Sep 17 00:00:00 2001 From: Shabda Raaj Date: Tue, 31 Mar 2015 15:13:30 +0530 Subject: [PATCH] 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` -