From 3ec410c5cf87de6ccaa8353663307910bf7891aa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hans=20Ho=CC=88rberg?= Date: Tue, 1 Apr 2014 13:41:22 +0200 Subject: [PATCH 1/3] New format of documentation. --- doc/_static/ViewmeonGitHub.png | Bin 0 -> 6160 bytes doc/client.rst | 18 ------------------ doc/conf.py | 24 ++++++++++++++++++++++-- doc/examples/index.rst | 7 ------- doc/index.rst | 18 +++++++++++++++--- doc/make.sh | 5 +++++ doc/saml.rst | 18 ------------------ doc/saml2.rst | 29 ----------------------------- doc/samlp.rst | 18 ------------------ doc/server.rst | 19 ------------------- doc/xmldsig.rst | 18 ------------------ doc/xmlenc.rst | 22 ---------------------- 12 files changed, 42 insertions(+), 154 deletions(-) create mode 100644 doc/_static/ViewmeonGitHub.png delete mode 100644 doc/client.rst create mode 100755 doc/make.sh delete mode 100644 doc/saml.rst delete mode 100644 doc/saml2.rst delete mode 100644 doc/samlp.rst delete mode 100644 doc/server.rst delete mode 100644 doc/xmldsig.rst delete mode 100644 doc/xmlenc.rst diff --git a/doc/_static/ViewmeonGitHub.png b/doc/_static/ViewmeonGitHub.png new file mode 100644 index 0000000000000000000000000000000000000000..44da44c9482307812e2b548c59c2a66354577a30 GIT binary patch literal 6160 zcmZ`-cT`i&(?+C;AOWR!Ff;>53q^W|&;?A8PC`eDNQ;Od1dyf?B1H&N1YdfPDoyH} z&_ocV7o&6$q}T8I{{H^%IlFVt-o3LsGtcaOW)m&U3>fLT=qV^D7>x{dtpJ(vx6#o6 zy=6h8IUs0UVFtQ@1fC_4bp@Pt(^Bar{h5} ze(MvjDo1{w%(ZfGakXW*WMyRqE|QJDuv|yfdooMZWnX2N5&&jH{pOO5i(M~Gg)0{$vo*|T3K0R;owL}HjYNLxl*gBsJu}Mdl8(1k@T5p z%dos6SY2hExc*w|B@6%XfcV|p^77=N+&ll4-pFivxa{ib{NfKwO~fRj0SXZ{FnHk5 zYP|D|Hkn_6eiRE%Oig|AcN^{lnbAgxEcQ>1S+>_tkNo}MQbR+r)YRLD=aCpjuGqL@ zaAIPjtOVG7;9E^*P8Rd-GQOz0PtIe!T$?#M5v6Q=|K8`dE#Ij|nW)(oBP$bzNc2JP z&`>IwjO5H~977Y&^kk<63@z;1ue~@*_758uI8OS|e`K-v2Zg!Bx(@4vCW%(Pl z{`wi$YhAhwTmM4;t+{RkeHLyu{Xz_**G$nBS&6vb!NC+vWo36P1`A@<(+EAFOeMvo zK0Fot!+Zxbmj4Dsm%9|4+eG8wpjI(A{`xX)K~rd2>2yPQdx+muy`Gq#Z~OM%@%<^ttAXWx%ThwrU7D7upk`FeU;_*k?R zXla`tZKeKIQEvIne7a6pP!^k6eS50GuPn?$-wZGN$65&K__M6?qN}4oebAPw`t&*G zL|4aM$*1JW`@QMh<3UB$#H8;-bw240b;TD?Fa5>B*qF6tjjP^q@RpfXu)Jl%gOL`m zyKymAg0XxV&EvNSWJy#wo&G81L))Lv{|o~~x6S8Cb{ zY2#Nt-P@(Y#k?@c3`xITGhq%kfio+$o@!-EYH2YvHC*_oN*Zixnk9>(mzAIvfkHzb zzW-9pDd$QB0H%?b!*DZOp^iJlI3>Wh^QerrG4z4LNguAG&Q`fRPLobS+uEak*z^I7 zqw^V)(@0fot*i8>xg_>ixXgt4)lm*kuANbH4M70tzvfz#YHDOg+m0~lhhZ_7DNC)I z2qA&FdHD~hwO9pjPY}bQ*WBC;aU@W2 zW>8+gaU(V_kFU1ut;Y)<5Z`gHCYy zx>(4xcU`tajv{b01bpkGt+N|!-dlfZDSrE0x*DlL4JR0vTD zJxXd~3fYQET|T-grC+=h`8jQSK3tp)rzM4JsZFRQYe&)6B6hNW^czih-f$!S#G!!T z@ynOI_whH7R5Y(F(c&W7+uzB`=^GFH{>!0v&!=R@Xp;r3v?l~p4`JZ6VRk37O5plJ zCk5K8vp3T!KF9|$9q!Wcv_PAt0=PjXav1UFc(_Mb{R6ZL+kKA8G&CBwMqQXGQd z73dbcW+o`am@18bD(0>k9IT|iykrP|IVn! zdB?`PfEZhNOO?3*V*3+yxE?|gTUm0FP|VXz>tS}GH6i84iXv)FLc({D3@OQUjEs8v zHo6ExbTso_(G-#EhezN1j-MQ{qKvZ^JRPpSp7V(|`Qq>El8uIu=<1drM@GzUM76%#_JwpBzLUWsr%}ubyR_csoW>H_%BiN>-pQGW z(|ZbLpSwXYx1zNZ*jhJUuRDAsZ!DUVq}%GnV? zb=m{iq*G$QV{62svp>EI+jpxQJKfB5IS&*W$nH@x;Wjr{8#}}Jedw2Edd;fI>+q6q z51pkI-gt|#*-oVLCiV|vb8`XY$Zy^W&JTHjQ$;2SG5vGWx93?TE#??XAspGcu#JjH znN2*&>{6wYl@&S+*F_KPW}wA4ravlPnS?ZHJ<}#)=ean>%RAr%&fNAnbCDNRRQ7+C zM_Pq>_&qu|QtMU)s8qaB=9*E;o}cA#_GN5-8s{7UWITx1*(Iqe16)1@KqJOVFl~ZR z^ZBUvgbQ@}zWO_N-19gEC_AijZ9(%uyBj;N66|CFIqGW85R;-(nGBF-Ul?sD*K0>D z!|TGY7MmCYHa)=kdbr*7gzwyExAFG=r_`cGC^BMKKwKr;Fb=-c&sxeUQmhiVJ?G}y z6~i%K#(RwEeI5rucwdYPa#YdsYr`L+tOS?AotnI&kFD-JZ57;LFrruzP|kyCg=W_I zs?i)rJf975aU=R~+7Of>M^P7dQ^CvXSM19!|3sk!Z!a+;?Z2N+y-b&p>AbL2+Lrlb zvf`+>&R%+c3znzG&1s`mP1d*=Q-KXdh+E6KO;htx6deZzuL?YWPu=x{t`r4jUDE=g8{5*zigycgVfQ{(cYR9BL6FmaH{3g-D+YN)Y0jj1Aa_XXBHY!bOi$Nof=9cachjG1dS(8+$&%ol_0M|uz8r0intDtad-*Z~*SkX?H|oaf^t zJ^H@!r&dezuox~ZVctK6SbsPU0_UCZ2Pm`JZmAetxCq}s5nlrtH&N-JqhBllQx9JO zt#UEuu(}eZr1mK2rrKXbXn!7XQ=2>IGBjUUBS8=GO_~`kLua5)y5%W_rxuioVOE7tp6AWpPU9dG_$w|vA(Kr3ka&q9Do;6CiV1dI-8>2c4oTf;SyRgXTGGhdA^M7i`RU?c#03FQX7a!5_vE1cp^S zoRD-?a&{&N9u!I)3bVc9W1E-o^n>%z**6Rcwa46syJimU^xiKaH=??Wev3I%&t~8G;zk-yhdAihRKGKQ zbI1eZ`<)Fz(ClIm1W?ap%NCDd{DHunk6!qM7f<7BhOF00zx%_y_w2hz@(o*-&3X)- z?kVF=XG4eKgr*~(8YJiEsA^=HJ>;lT2!dc|pU{t`ISPV6bBh=RHX$Eddxg6V!X7YD zEKD5<2XjN29n>OwI*-GD&G0<5{W6v=ezyc*^v}VsCH8n=mBlEWudhHUO7z>wG;-g3 zjaXH9B4nL=xVPeGl^`tW%o|1h=7)QCBu;8qx573RT=h5_JUm1T!!5Q5!Jx8G_o?ng zWyqw~B^)F+->fGhn4>P~$Fh*&vh**WH<+v%O{I_5cR>%{I6gZ=i;xK9`6t3ay>U05 zX*mhp@43^DmA1Et1+Q~)EO7@gKJC~PzO6W-$I;Lmxa4I;?3gIKH6B6YdnEnNwiexw zgWy`wp?N^Kem+7Fnws|aJXfvk_tbhlQoIFCrbdySMtoS4j?-%l<#xAA9x^a6ocCfQ z9bba`;X6vAW^cqeaP~6^HaVf&vw@6WMGw7k+`lrMPL(gmR(~S6NSBv2S=703S2)t( za==x8_Me~tn_js5$O3Q8p76lb3qY{?N{cI|otOC>4n@}8z6V7)Rmp4bqGn>`cv7Ez zGXUkKC-!BATR#jLmx8H3l1Kte+aDT3ls$;>9VoY=pLT^+pz}l}V8x?bJvW?*b#MM5 z1TJYZ;IEQ+Mo39V@tsDCg1WyJ8<#;L1ALmsu0k-}aMzGEx+K&$s0Jx*K74^B4oh;v z=G-TDeysd-C;E(w{b`DAGFQLKs{J(%RU#Bkd(**AHz^|HHnDA`pr420Sn)v-2P|)! zA9Cam>%|)2Hh$O$K$H)Xch$}4y}EPp&uZ^BEw@dO+%8c}OfYnG8-BbaIx*0L?F$dH z*a1V1_+KZ3(;(r;yAa&tMauVAuAIvH=fzmsc%;m`88({v+$k$p94pSg+m7;y1<9{` zOT0X4_uGpx(%8CG2XVsnyqauqu=VFhz82gL@pi=X{Eh^t?VQJMrVLzc0Ba+mMU=Hs zI=`n9=)rDf<0Qba2@jA@-a{XZwipSIXr`!;nXHh_3tlDARj!D(!R#2)A*X4sQPfeEbsJ;D5mbJ2&o!Ac{#U9Y=%ddN0CQ z=c#8)ogt+&1=3{?G$oif@aK%YNs1*WyMsV#B4^5tsC%(JWm23lK15Kh`!GBRSwsmz z#M!00+I`H1Ke?Td%^P2{4@I(&>Z{Ne26V?~{?`Q4qLbrw{X+Uk76Q9|AEb=pTRX6N zj<{s7|J^M;+)Pt#$Uz|srJCU3=QE!?3J}R(XL|7_m9{);>SwK|)%OwI*`Ev1n=5Oj z%ptj%4T0_Z2tvHUH5gks;7e5k(!fB)y_Wphq6fZ1`nn$WI8gGMwtz1BCx4@si51;ZiqZ*8puJ2hA$j+(E{{bNCVcp69JhtWyV1`jgo=7r7|SszFF z>VW@1#8rrAmsKM8koN;rvT80BIUxoX^c7fLh(hf!npaFXRp$;l+{RLYA$$`vv~&rC zKEEe%-=pS@>pPT}>>dR=hW`~CYX`|zVlAC5{cBCp;|5OS879Fl2~C_TR1p>u^yT=n zw{4qh^d~`k`ep;X6yB=0o?fy|tv5@ILaFUBo8Q{Eu4MqP{|GnNv<6cs|S_K!^_ET5&9zRxfO3T%+lQ3i0SJ!i<(Uf>7dhpVc z6$NmA5Cq|be--_y`x2A1zq8i;=tR(N;8y>$m9YB5zJR3QCI3z5(h63*LX~Y;0oJ9J z2Ig3;X$kx$t;Jn0ntO|jd24PD&CzuyI83-cz4^<*ZrGz|@4cr@Ye4HMvD)z!xC*Y- ztlzaNY;ap)V=J>{~$#nCd8!q2|zm1cY z;KbqJKutj@9S8PoU!nZyU&5?M-(U`TceloMTqB7Id)1xZ@DdJx|?$yXnUP8?axIA zhAhOJEC0H_DVuIP0)iHf_Zls6^L8yzg4O@CssC8TetQ2FKGQ}s0Xi@f5|<#l7+W6D zH)6H0FrMpFRjl19^D}MBUMcTA5^m>8oR6wHt2Qaml06WW<@bh%s6TIw=K7`4H1vad zHb6|g+J7X;<`buCbKR?^SI0L}53FU&Cy>NvG-`d=l3N{EN#pgAcC-Os5#@IDsmw=K zXm8Av1EzM-jE1N=^@?^kx1QN!;`nb6Y|r6AtY~znjy8}S1z~}`lE-n$he_YE=;yW+ zF5y3V1$f+AZ}WUMJSN_)O4aU`Q|fHf{9imyKKRV%O)2=W6oX)F60AQ_1FOG0I~wFf zYi@Bhw!fakk3}BKZ3T+lOgy=F&9dUQ`dwo6j-qLf!uMy#dk^6|?D)uc9kjIR1!)t; z6wuw^{w5yZ1!>yGt2Z5-h-fx2y+2^oX${$yo`BpA_Gl}f4hdZU!0$cl!r=5MPa{t= zXv6ZIwK#qP))LE5MrX3e4iEYWwL5=t(?(|C&Dv7bc>r6BP-0&w(}Ign+#{FMEptpU z7-#>M5-ZLEbUK8=lwJIe)6PxqH1t*aC#s+@-fh6Vt9Pd36y*id9GSq*)|g{Y_U*Y$`UtvH}`O*O{sWkZx@EM;)^MSoEn z`4gB|!o5}{@pKlOWDjhsvmcuj49LgTKc7-f($ z0Ou-!;X#&vF|2{J7gdDuslxTaT@pf&rqaKAp@mi6+v0>>V=Bq1N9;_4G8oE01agDm zU!5XgFgOW(uyK?O_J}lomJH~)81adhQW!V>#Zg!rcf8u!}W-0=;k{GWXT>W8)ZLW^AyzTG1r1 z|4e2VmT{-=zp)|T&%o&}3sD{({4(J|)W(39+YvihFyK-g8+_-3S7vr*0C?-Ka&k+s zehOboTvPZp*!k*L_+Q=OVBF*7um3G`G`zYE)TO^)SQ4v0bYQ3J(5YZ1wDNz-tA?;S z&`4Gs1YipO-|egTDzX)qKlLLB_Wxncj8~;48Qc%Jh#w|(5d=(QSXV&obVLIsT@w;M zg(4CJIC1;%ogyRP^0iR-&&%~kuPZ7lNb~dfYz3d^OTE3?;ES6V=f2>HGHIZEw70iM zTFXK12>>zjiX;MO!(W>K$ASy7u)m$l|Hgm?{@)iDjps}aPg@77c!f!SFZPY} L%ycWYon!tFNUgrn literal 0 HcmV?d00001 diff --git a/doc/client.rst b/doc/client.rst deleted file mode 100644 index 10ed65e..0000000 --- a/doc/client.rst +++ /dev/null @@ -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: - diff --git a/doc/conf.py b/doc/conf.py index 8397b3d..a1340d2 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 @@ -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 diff --git a/doc/examples/index.rst b/doc/examples/index.rst index 9a32d16..a53212d 100644 --- a/doc/examples/index.rst +++ b/doc/examples/index.rst @@ -14,10 +14,3 @@ Contents: sp idp -Indices and tables -================== - -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` - diff --git a/doc/index.rst b/doc/index.rst index 32a3654..1266adc 100644 --- a/doc/index.rst +++ b/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,9 +22,12 @@ 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 + + + View me on GitHub + \ No newline at end of file diff --git a/doc/make.sh b/doc/make.sh new file mode 100755 index 0000000..a364b54 --- /dev/null +++ b/doc/make.sh @@ -0,0 +1,5 @@ +#!/bin/sh +rm -f ./code/* +sphinx-apidoc -F -o ../doc/code ../src +make clean +make html \ No newline at end of file diff --git a/doc/saml.rst b/doc/saml.rst deleted file mode 100644 index 377758b..0000000 --- a/doc/saml.rst +++ /dev/null @@ -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: - diff --git a/doc/saml2.rst b/doc/saml2.rst deleted file mode 100644 index 8c56e5d..0000000 --- a/doc/saml2.rst +++ /dev/null @@ -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: - diff --git a/doc/samlp.rst b/doc/samlp.rst deleted file mode 100644 index 09cf5dc..0000000 --- a/doc/samlp.rst +++ /dev/null @@ -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: - diff --git a/doc/server.rst b/doc/server.rst deleted file mode 100644 index 0f02f37..0000000 --- a/doc/server.rst +++ /dev/null @@ -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: - diff --git a/doc/xmldsig.rst b/doc/xmldsig.rst deleted file mode 100644 index 101e7ad..0000000 --- a/doc/xmldsig.rst +++ /dev/null @@ -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: - diff --git a/doc/xmlenc.rst b/doc/xmlenc.rst deleted file mode 100644 index 9f83077..0000000 --- a/doc/xmlenc.rst +++ /dev/null @@ -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: - From 62914b4b5f23e3803ef40b405affa23ae5e6e555 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hans=20Ho=CC=88rberg?= Date: Tue, 1 Apr 2014 13:44:05 +0200 Subject: [PATCH 2/3] Added dummy file so the code directory will be checked in to GitHub. --- doc/code/dummy.txt | 0 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 doc/code/dummy.txt diff --git a/doc/code/dummy.txt b/doc/code/dummy.txt new file mode 100644 index 0000000..e69de29 From c75dc0766885feb21f8dc1a07a0854f4caefc8bf Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Hans=20Ho=CC=88rberg?= Date: Tue, 1 Apr 2014 14:09:51 +0200 Subject: [PATCH 3/3] Sync --- .gitignore | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.gitignore b/.gitignore index 61ef1af..54ce3bb 100644 --- a/.gitignore +++ b/.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