From 095e97a8e5a339f6d024764194b72260d573caa4 Mon Sep 17 00:00:00 2001 From: Dan <14043624+delivrance@users.noreply.github.com> Date: Sat, 30 Dec 2017 19:47:18 +0100 Subject: [PATCH] Add documentation source files --- docs/Makefile | 20 ++ docs/make.bat | 36 ++++ docs/source/_static/pyrogram.ico | Bin 0 -> 16958 bytes docs/source/_static/pyrogram.png | Bin 0 -> 13344 bytes docs/source/conf.py | 183 ++++++++++++++++++ docs/source/errors/303_see_other.rst | 6 + docs/source/errors/400_bad_request.rst | 6 + docs/source/errors/401_unauthorized.rst | 6 + docs/source/errors/420_flood.rst | 6 + .../errors/500_internal_server_error.rst | 6 + docs/source/errors/520_unknown_error.rst | 6 + docs/source/index.rst | 26 +++ docs/source/pyrogram.ChatAction.rst | 6 + docs/source/pyrogram.Client.rst | 5 + docs/source/pyrogram.Error.rst | 14 ++ docs/source/pyrogram.rst | 7 + 16 files changed, 333 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/make.bat create mode 100644 docs/source/_static/pyrogram.ico create mode 100644 docs/source/_static/pyrogram.png create mode 100644 docs/source/conf.py create mode 100644 docs/source/errors/303_see_other.rst create mode 100644 docs/source/errors/400_bad_request.rst create mode 100644 docs/source/errors/401_unauthorized.rst create mode 100644 docs/source/errors/420_flood.rst create mode 100644 docs/source/errors/500_internal_server_error.rst create mode 100644 docs/source/errors/520_unknown_error.rst create mode 100644 docs/source/index.rst create mode 100644 docs/source/pyrogram.ChatAction.rst create mode 100644 docs/source/pyrogram.Client.rst create mode 100644 docs/source/pyrogram.Error.rst create mode 100644 docs/source/pyrogram.rst diff --git a/docs/Makefile b/docs/Makefile new file mode 100644 index 00000000..c647eb13 --- /dev/null +++ b/docs/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line. +SPHINXOPTS = +SPHINXBUILD = sphinx-build +SPHINXPROJ = Pyrogram +SOURCEDIR = source +BUILDDIR = build + +# Put it first so that "make" without argument is like "make help". +help: + @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) + +.PHONY: help Makefile + +# Catch-all target: route all unknown targets to Sphinx using the new +# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). +%: Makefile + @$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O) \ No newline at end of file diff --git a/docs/make.bat b/docs/make.bat new file mode 100644 index 00000000..fea543e2 --- /dev/null +++ b/docs/make.bat @@ -0,0 +1,36 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=source +set BUILDDIR=build +set SPHINXPROJ=Pyrogram + +if "%1" == "" goto help + +%SPHINXBUILD% >NUL 2>NUL +if errorlevel 9009 ( + echo. + echo.The 'sphinx-build' command was not found. Make sure you have Sphinx + echo.installed, then set the SPHINXBUILD environment variable to point + echo.to the full path of the 'sphinx-build' executable. Alternatively you + echo.may add the Sphinx directory to PATH. + echo. + echo.If you don't have Sphinx installed, grab it from + echo.http://sphinx-doc.org/ + exit /b 1 +) + +%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% + +:end +popd diff --git a/docs/source/_static/pyrogram.ico b/docs/source/_static/pyrogram.ico new file mode 100644 index 0000000000000000000000000000000000000000..4165f9edce821093f62506253dc379390f17cb64 GIT binary patch literal 16958 zcmd5@2YeLA^*;W@AvVp16PTt(FOp~mgRw>Lp_oo62G?MlVlZG+bSD84AUc>TnnY29 zP-3uYqBqkFrWygEqjJKrlQ{n*FW)zJdz@B#$LRn&r{B};%6t6a3UI_k7O4p8*>aAu;y{-$TN#7OH>g@z+H)OrEACf3- z-dih82doi+0D+pdY}8MdpxczhP&PHcO7?d7uQ-+=iw@kA`Frll>>YPx=2y2B z&HDN__y+yodry`gzAtOeWPyj&1D%ebu9Qm;l}>dYmMlR{rYT!$=f5=;qd5KK9f$?)+l2M1A59=_N zHeUTvCZ(K{*ZRaMyFgouer-knIQ2g@9%$GrHi?7WEwDQlA@=b8Dhiv8;Ua-BJ$sOTWHLDs|W^;qM=l zA@eUu{K-s7JfFJ_wwH7vN0uMGD}yF|EoJIX(sbb*c+l9vgIvBtew9Mgd3#+JHP&h4 zx(rX1r3Y{4!OcF=&aFO`DZdA9%9*%~@apmF^BO;b+onm~-Unq8c)8(nPA)#PJ@T64 zW%ROR;@>DnndaVNb||z8DKy`}&l2arpcL%13alC5GBDJ$@XR z9X<~5Z>H~EqtzVcldd(Gi`nj~6B$ys&mr`Qn1C4=13H|Ppf|5bQ1@#R)Z@k@>W*uc zb-5^k?T_PG%mL&@KKY<*D#pT?RaYg+U|wLq65w0+7`;jP&5+~I7zZ`U1HU?RnHc^w zdk>$s6W&p4mQhO%3+G!skC{)tkS*QDoxxnbO9EOSkf5%YCAile&|L}cea|!TnVz>K zsPlR7AwV9d4S9lhz_Y-PC-bcbw1=Hw3sNr```alOAIi{q z2b3+KJi&t@#8{wQMTOP%pZT|KR2I*S=d*!WyV1W&zVOgc_Nnl1!iSuZz&Fz+xKD-; zxOMu`=RWl3BJ>EhA|HAX0NtVg%(>TCM{}fc?>KF}knUH1+H(YIv}T0x?}C-)_XGUT}hUT$n?qynuVVIPR%0sh5rY9L|9W zr?ces5l>O>27IC(csoZ{?X*wEuf67WE?5uWa5Bbn5yWJGF%x54t(RTL0Lq(!ZWqCP zAC+`g_zroeC;EA_c4bQa51uW4&LM%nKjRe-I0oLEbrJZD`%Db9W7S&D)^uR9xpqb_ z6#({+DEpw-rg^L<@w+UsZpx65x1WLT=h6f47ybh0)yLUGt{Hp7A6f_5=;fv5ska}* z?p85HVBLl}-cMry>>gsxmQ{?gbsCo9c74OTl7N5A+6<{a;928m{r531LI)l*A80;t zJl35WUZZr@wkz<5RQ!xFBbWFgeO>E!zY7>6*7avR){%TZONOn4?f-)T{$42S3F_e> zUXxg!OSazTX$#ZgJ9}PFQvU6RpOodt9(e3KV+A!^&rxx9;OzmMr{V*UeLeWee=h~Q zzj*&mk98zp0R9y&_%*zJ?@7@684@@=QvyE)jn0z5PckLw!wd-;0A1F2@fbb?;<*al z?n!x20QrdL1KJ+)r~|~`cGwBTLOkPN_04_hJUm6klYyW6E)HM7(u%%*olXl>9NI{C zw6Y|~e^h*?RPAS%Yv9lf@sF}eg&8?gVWt5&%Kc+(5-=uHf(L>ZZuEh88x6g$_&X{A zF%-)K3GNG?Vm;w$43xuqsKX~GW#u=YtCfKA7`dHY=AWx_zPk0hVjh)FIJl% z%?7P@#;dh=^eOG%#0{BJV{E4Q#{%~p1I$KzVA(7?1$>q*L2u=rKPdMBvmXe3E4INj z^-`9MOU{xSy)Ssg&+*?4K9Ihz`aEsm=w(N-=cN3A!_fQZ)&5+lHG;OU^YB!mj_BWW z&96rtQx9fK$fA7U*7E~A^Pg&yz@g9w_)vk6dyCQcW!X`CJj=DcKYeeL-jlCMfCn2` zq4^#e82z1FA6To8>p080Gr~9)_T%nD?nTU@mfwO83yM`4C;cXViCCj&9U>3oPG(8{ zB{nIq$CaNvbz$~H2^b4I(f7W*JugFOTeZGwDgFBBEw??&Ke+8)8NT?6TmMI^i}2rBEW~Yi*YtOq&H=v*G5}^C}!Rzi>@?m_oytgDnQea#4 zZ4y7%H=f3SX!irc7(3Ub`uAP)ToX^-d_jU=pHBI6Jy;yF=ic2q;(u@YZp2bO&!Ma@ z31jo~ofyNjpI{8Q@T2VX9OhTm!Ev{7QP=v2f7+IdQZYPM zlRxmo28LKy7ODKX44z`&%W!?i=z1OcwFXpu{?oy)>CtE4slGk#e+*lES?J>$@gS&8 zntZh2GWK8G`@UM8#2>Tig4#F2e9yH2@pDgS4#$6=aa+`$qxQU~GzDW|$X1(_iG4ae zD2sWr_QD)l@=b0X*l^h16dmR5<2QfAZ{r`X9FN!r#LEs~z|HOn- z_OV~fas#*vo5Ln^{_nvU_Z$6JsQo0Z?Z>6;XUzU=DF@j-(OlrL1?5ps<+(W$kNq6B zt@cx3*J^al8xwjN`)TbzIq8+$U2%+Bd_ErcYP6m$%MRUf^4|45 zch}r|`e2JqN;yRsz_yrt~>PdS%I_v!C)uXG9aN8RXRPPGd?M`c-jxC@a=(Nrz8!#6xNV_YI2Om}YqMGev z+?V?-(VIQ5Q;hn#^7uXMy1M_vdXD={4WA0T$ddOnM1Y%cFyq3@SI&+{n3I5WUF2k_bh zzSRHPQS<@l(*`tuEB>*5guY(p>95l-d^6F`1KI>%#{q50{DT?NapXxSe)6FX_F2ZQ zxu*8kjr#DoGM+0cjI&t4`WN7@O5J~{=4d7+lnun3_|KQ?M9Er*{drt{`uo&_1iU+9 zd$zJ;zRU}>ffeW3WaeS4vlm`gdurxJJEhCm(`s*-=L+=gdXry&&W8DYE6y&c_(vk* zKgEgLFU)>s2>hrI9;9;}G<5EM6*u;#UZZE|A5GeuEmh~`sJX#gJs|dAU~jl4OJa}M z_poBN+?1(XZ>s&y$N9HLebLH@zf3*nzVH}g*Z+WjBmJV9ZRVBZ9 z^LpGn(CY9dW&iu8*u>w(*EiCI0IVZwF15+4>$2n$N$% z6}#)TIb=HRAkNQNq(QgEu(5g19_6PG#7~=84?ZGsQ^p$kW8FtxueR7G_2aXpaiRk| zc>zY`w!D&H*Y!r4+>uiM`~4aC5d-q3eoxQPUNGia8)ry~ z33S+1-tMk3K8}>c9Le*zix1p%yZ`N}ZS9^~D`HM)0&K+F5csI)9OF)Xcfnr|wlC_y z(;53bD>yK6yD+Y6$8UXA$=Y$2QIB8K38Yo{JpH7%qP~(f@EbKezN9J8)kKe(o=3;j33%`%SrmMM0-?@fK4o?#4&u}p`rhjqTSE%BMdrs!dM%;P=! zM7MbU{1wax+#B(APNYsZhHg{G^*mr1ZD7RyC)a!0d!CV|AIC8a3=xoJL61OnH?cqN zEW!J|P|rWOKhmhzGIj3LCmvu7yq@F+KV<*T_AKYR-;-=T-P`#6k1B@8Z!H}0tt4P6 zN-#M8;Kbz31?_T7rZaIp*jbg-LF4_=lJm0lyJMf!Iv92T$aQl02GKGh{*-E)bB!mx zB(~-7XX^t$?Hpwujb?|P_zp4Mm7(T{g#N#{S|>=67ruJ5>y;E8XB_fQZ08h$S{ z;){c7ez(W7EI*--v&~_S^IcCt?s=HtC_p4ddqS=dcq_XFz5-9?#U| z(R1htb%=8e$M-<%b}5f@{oJ=@8xF!c)!NV;5}|Ap0lCV@XMp*5(e*4bz6Yy_ex-o0 zuWb1zV)w{o_~UbcXEDD2TZUNVvLkowgt5Hz;4Q>^Z%FLcOEM3_4dFsN zukBj)Yh6B}WuBWiiV5y3<4$@bVHbF{ijBBhlthI0* zgtRm;<~gHUDlFQ|7XLRM^Q$|!`qy2B002_yE_4b!zQ={hoHfOyIXMA1b27$;O_1g*tom92mR)L-d}J|?Q7de zPjydMtyR@EVM+>8s7ORe5D*ZkGScGTAs`?NfZzTIaKLBr3fvO#1!we4N*vc%zc-{PeTF-*5#CuwUIKm_1p@)Zaz5sk1_40XpHn**-^Wa^ z3tkG!{|{1|l80kdV3orcc2nIYey&1?N;jkTYd08C;?GUJ{whU@oG2ji$`@frt+({T z`|MVSJ{NL3wtler?JGnqzKQjlEj2pIdlNF!fN+epnmNroTvGL8-rh;-fL&CB}pA+JJ>0J3&f(}*c(;z!l7z_wa0YqbdNw;cb z0{u5_Hp~o#)dzH|oaa9LaaK)*b8yMXa$+nXCO8-k6@1E~?6rLl7)DVae|&CQkjJLo z6{d>+uN4EOs%)DAaUl$*i);_t74kCRfObf$57)pyF zU;k*7X1R4_YW?3{Eh?Q?%NR72&fbfTriU=&YF6PFHQstGK;k3o#5>*+B0HzfmrxsT zg}9{@D*x}IXSu=kEgyR#9p~9A-9ElpBIm+WarI39-H=gwY>w}6Cfd-~(J7E)iay_` z>i+K>xx|ctcgQ(qy_csM#YH}}#%W)*sfPdUqwW^(JMx!4cYgPcSNB~}`B_X$0|?5NPP2N=`><;NEAk>@NP_eZ&gN*GW~r`{jIO<14Pv3@9UR zn1995DI`=uNH-%)mn8K}Dt{g8R_K=XpQ3Y-o}co&v)sL>LJ@kxa%S_!C<#ZuK!4jDWTlri4=862W6$D z&l2bfICb9y)!vdGev>YR#jgv|f9_-WJjB2}h$vM@S8~I!zpwvftgD|<+Fqg-+=nEq zsf@MhYhR($3Uv58=NKZRYtsfW9A{J+dy3|CvfnuK6q~U(x{|I+RuSeG^PGn`sEe{H zy4T^uLO=96Ceawfsludzsct37E7ISY;LtZ%KHK3@$x6pJ9AJUt)dP{a^Bo~%y}PJr zGkMr|Zo0Ba>Bp^OqHYsPk?n9)S7$3O?2e-- zDr#`EE$y5V>w{qX?bZrDOY}oySleD_rB0KDHdP@;+_?Jx?989w=QS~Cts+NOz*XIq zi(pLSw zjz`ylcIp(!9uBa`{2i46o&!4@mIb^k1UbZbfLlP8NQo(t36cIsHHhfOBionJ@ns8b z9CU_LdGuq8U!<)=DXK@Z2ZF3YZg;X!-8AjDH$N~VA9OjaTC7P-HU1QDPqCxVEdNwi z$k^iHd4n@RC+lcGX2D7O?t8I%i9ah|ntpLQ$Mi>}?@bb#ZGt1JrTn0q#>GfL=dX-i5&!W@)2}Pe zzg3zpM7R_SiwTJWPX_;`EZx`T`?q+Yi6!%q((Puu@ciHWb02y2`v)Bl92+w3tLilg z$$ta|3pQWJTD0u5g)YvTr~kU9p>BToUZ^Pi(XKu1IO6VV+dHEwB)Br&5;PDInIuA3 z%eQ)t=s|#J{2m_<7#5mKh_^uDdv5{ZO=WZ0M}cd_?95YVr&OmQ7WG4j(skVaVMp!J z`fUl;i3VT8`R=53rn~o2mC?)*{F@XhyV*(B$H{~SSRf>bwg+Y=%qiYe&+gC>-l4^m zNdCqJm>EY2>B{T38f}42!i|3Y=Tfi6)mWJRSriRE#Ij!6Hrw3h9L5(|E8Moe)JdTb zXH!%C>5D(2?6dSdOuN#}(jA#&=>TSC_?v3gdrtOGpHQGL2HV5V)e z3pEI5P^}i_0|-)di9T+fjaSFkB*V}2An=G`^?*DPnca{n86ZPP9Kt#wwfyTKt8!C!%D&=%tQ zIcxad^Q*eDbVF12-#WwH6ONEU$*IkZw}Et0?Lo6X)pnAc8ADO z-t9*emB6Y@bV2k2&!_GCdl%=&mt}&%pbUsai^3l?*;xtFBy$~2X6O9oihm)SI(#*z zh*GG|@I%X*yc+zFufAO2Z++TA?-5wLE&a`u;a1^o3e44?0V0p{_mA?1Bbh~@HQob4 zK5a$D39^u;MBTS-$kC53$D3_b1py(=t5pT(zqz}ooBH?9WyDU412ai#^x-#LTkLV` z!H2|4P~L;o`KhKv3iwfsC^(SAkWK+|qEwBV#q1(oUjTmwTS3UR#+|e@P#vs8WyM=* z;6=iq*Rl$MBjL9bGPW~0$(k&`V76Bm#x+0Q8x$Bk`>P$N`hDc z{`7K0<@NYM7H`g|aQU=&+X7ucN{$>mV9IkJHEwPviu<0s?viV4BD@nJ=chW3o4IF3tBm`5ZWTBb+>6tvSuA}C1P2IO{jZNq4tpYN=)QW{B zgxS;hdf5}7dcXKoCh!y7Rh>63px-kS;rwO+=iNkzWlPD4CKjnM)6>RpYA^TF&W|9K zQ0~T#lHmRdpJUCifmqw>H?QM(M#a$o#=X^|(gLdU05Uww(Y*jM!NvdM`dR=0_OL#x z0?HKPxwqpbG0O@+G5Yb74UMSxm3!6%zYmgOA$wX;+QFFT%E_?d7>m`0{p4M}wVrl- zIpnt5eCQRt-ccS{aW8%d^4;S9;qH;P$=nqqH>`5$bwPI^nA=lZ;HYRtqw4&D`aa%% zU2f#VVIU*D%Kb1itYpgF`Fi6-&8yakA6>3u(j zF1N1PmAVhhmXyU$n$&8`dkrRje6rYHj4>Ht5I#b{#}`hPna|?SxbQtiVXoVHwe%`5 zmrr5c!23oYT>s~g`X3+QrtcU4KWa~e`lukJV_DJNYVWKPFq?OHe|N0x=P^whnV;W2 zTgY^Yr$FUM(d6?u(ds3^zk-;{BinRx+|<>TYI-Js81_K{G~&c$>VzjIwTtRAB!G|f z(S8>H>-1Fb-SKizG!M09S<#1jWA^7L|Di&92fk-BcF&YA%gPHIVp3`PJ1t?kwCIj- zXyjOxj#$6g@F@)+%Nen*b8g|8q<I&iyZM*BVTU z4ty+HyueR;63Lpe$DaUb%#VqWt041XYo5MiTe&Q%8&B?BbJ$F5kieC26qT6a=JZKi zU-o$RN+EF?nd5&?a^sMt|A?zvHtqQ?GC28@QQ3e%O^X&jFGF4x%NRC_p+IHGQJ+id zg{t5;e02Wy!;Epwu2s%aRz3)e<(W@pnWQ#!HE-6J)ubwzx50kn#yi_<878*o){N6- zwv$QFg6&xEFP0iO-y!|103-P4&bnUM? zfGpqV%k$Ug`DHVXy#D-T?=ENvv-okre4cEXYxOLy28OTFdU(I^Q6S8jI~xNGnb+tH zMq>W1+Ko#pVj^k8z08;{Um=y`==q+uN&ZFdb z-2V19DXF_{Ym2n{tw&O>NtC}9}1hj+gWQzDIu^mqN9v=+xVA-E=JTipc@0s=IWi^lWMYwo^4|KWJZ z2#^!&8T}|BDw8dBGPjp5!rk+%JaO5OQ%?lV3rn^o{9Cw-S38CN+=05enZQfONEM&0 zCiYuDQQ`7nrNUVB4tzr0J!6U^r(`P)-=c`%aq94`>q**V7D?XsDqaf66JnD zx@?hdFrxskdNafEHo6jK<8DXz*{6Hef8IaohOEd)*dTLpv0s2g1!Bm8&wBlu0Noq= zDW7`-(LSLKR};Adxx*lBsO{n=&P6Nd5W*Z<%H!?wYNY|s9o~I`BWk`?)2)l8mkZ}jW%==ocg6d=B}%L6#JKICi#g|Y%I(u5evHG})C6aA$jkl9%$fP( zTEoG^IKj)hmy^6?PQBc26n}|&aJ5bya~wPeA4ba}_H%yA3P;qcI80Odv33Ab&ZIDa z*->O^f3BpJVXXZ>kAsZLi-jS)`Q`tuGJ`Ru)OE^^Rs9~~a}WgLzi!66!?h4t)X4QC zQjKm~*ivyFgqyrj^=S1>_CP{*M_Dt02^J-e-k^B~rAX6}HLcd9q~9&kE``zifoEVM5Bi?h8z>9L$+MzD}L` zM~02itw7XKQso@MzY_UXCF4tIqZ|qofB7Z@$z(E|MKGs9}LWFT!Y5)WB8H| zd%)YNC~~eU)?_u3m&0_L^Qwd{dVvEi}!tbTisZnM9Qgyj+2 zO158YYm93lk*6|#>SVXAVJZpwvP@R>Zgv(1smikw>z0+!(kKR5-IlQ%q_x{zHa`*a ztAX`^0YeeBi+c*C6?%}ntU~M)g&e& zWCPT+>+Pf8^PfY_X;r$wPvfBXjsD+hwxqxrnjbYJ4DZ#kF3Eec|nF|*FJrMD849OXGLris6!XbD|~?3F|@DxyVbo~_jH z>GRG+cj=J;x^Q_=w(95)gl0JAS}_haYU7|E0&2QAFOaxg^O7s;`61tY=GF%%w%3k# z+Y@{cf&i{6j5`zhUHaycH~seO##F=H<&XM<5t)q_gqP~epL{o zw7>p+6KW`c&FNfI(>%E0xd?E`g+X~m+6r~t1ta3C%KKsPa1GxIEpZ}BNVpZBz>rp~ zNT-|n#`W6qV6SbAoBIaWl%6dkF%eYWAKh~?C}JJMO|y%dbiNRVa2Pm4oM(ie7REE% zK@nj4DJ zkRzD4x^w<6;aC)^HM(lrxaB!l)Nf^Pe(d9xlCtde6`l18r{{UT!jmAOywIT)Z?T?% z6lJYGLOYoUPeHIVnLJh5@ETmFpfP z<>^&hADO*(2S;{_jMoJ|ayZNWTE(?<)H7Y71*-Do4GZ4FF(x?n!i`(MDPa^cM2G9x z6r{$8B3ve>WF-(n>WV#vU7sbM(Rp_M*58UrZlAGsqG2$nQoWMhD1Z2t7sp`YWI75t z?OvcRK3+ZM`sAEqhb@(F44d$l7i)atD%HFCQuVk=GY;yqPaEO_-2Bk}#WUPSCp-C5 zJ^n9I6KqGCt6k8b5JXq_E{=AwBfz9NnZP_tw_E93wx1V}nrv-T?(2{@e3Hy`Qr;-8 zEA$pBgIabcQG0rmEh8Tfj`));QI1U~UFfu>o?B89$iK!BXOf818ktM_2^~0`iT8T2 z&DyuU5A`%Cf5&Yq9)$UQ;x@Yf0qSqUadq9@dGaI4&BrzcaY2%NtF6+OS(h;&w zy&^}{{|p$VkVDzD%bs;EKL`)k?U(3Bej;*x|6&H;->zVO81|0{YtXT-@gpMrnD0Bx zkwTB6MJcwbJieBbM0W9C;te$}(iJSh^9yJi&%;Nk^qp3+xVzu>@~Ir8{4<=En#G2@ zo5_AZ>~~KZS+k6#nAxZ$j$Fkk+Cd~Uobxe~Q5kKvq58< z=ZI2pV@bYbkKTBF{aPa^O6Fx{ic2p`oHnen7QK`;;QU0eSe9qFIEybvQC0;;`hDK4 zFaC!wkB`|)i~ajrUhS!918bBK_rnHRN#{NMDof5oYdAk%&H30JL&|5nckZ!+m~LV> z9x6=qgR$rYX}QtGD;}+2rAOC$Dib_o#gq$cZ-Me~P&8KdiyQm#j%+OligUaj#rA-#T-gS&bA$r|kFc zd9Iwc2-ad5Uv@n+0=%@iJm?DPD7oRey_M`+))a$)NE5|z@sN@SrPk9mt9z38CA(&b zBWl>GhDqX}w;Jz-!vXHXC;QD&Y|GpK)TAzt8%yTjS$<-cAE%OK+K~5*1=L15e!wOh zOO((FDPZ!8%-~Yu-9g{GK1|)6+q7;tGtJ`KgZghZQh?FubRaKK3H*FYJ-Z|d<7112 zsL{sdOO^<&j56R3ew~k%8Q(z)QxqFemkg~$-5u~*FkDqGsdDXIh!|RLzMmakUqKcP zA$j;$i689|_wYbYFXA+Tm}t%YdL7f+Cf9Om+vevfF_SsCx|8O;2^NPd!Bm%dEe%O| zxfCK}_z5AvIC*H@aV6ZDbiIqfHpvl140L}LAYT9?HOlRJ+Lw6P+o!k)9tJRi=Qd5! zhT>6J;KMUSaLpe7c0m?)H@j#@Czp(nJk1z=SfmZ%Gl5fq9uwJT>j8N&2ZJV4BGCh} zaS+NHLGXMJ-~xqI83+4UO4C_RDo?qkQjgw-cA3F!38$8o)E?%W5!sjWSj5U`4$)E>=b#4H3>qLu*Kb zYi_~rcRoIrbr7wfyA0YcenmMVvZm$yP@5?JsDvZrm{wU zOV(t|C)s+Nv?1%Br$UiSg$mV18O?*bLIX6fj6!Wk)^Et2??S`hf;*Zti?7v*nC-fH z;0g&_x>BwIO4m_bg@=8er=+FWl=qa3LHdo#nJETKoA^@~L*#ny)&LGdK)gWI(M^Fn z=%|5_#!75J7zJCKG;jBfz7`h~>z=m;c4!y+$U^wn!UD3Ty)c}YTY_C*KrpEdhNgt_ z*iYU7B)PE93X(sR#}st;)Sp>ZZNE1kk|tYvr-RJHF3$SaNtBCX!GxB2`5Ledk)(lv zSG`RAX>!;UH!-7Ia?`++X^DoV;`tNOofCUe39)eKAKD`rf!LP_?~u|17mPC0GW^&_ zozLC_-I5*f@$gj~?OoJ`H*l{AA+n#U_b_hg&p%3!;8Zi5m`5QH5)bK?b8rnY1l?Zt zGEXi}!1uk}V4V{u8#mU22F9wNrG>916|kmZ3jFRICpI<{E}^&j0xMmc)-^t0XZaGc zQcQP4m3&w^8XuSo0Cc3Ad;Eek-oL`oRkLq?jBh6;*_2jYtW*WfrlKrvOID$Yj;LuD z&m@oLR_w0V@D;kDNMD$7W^I~dw2Si>!ZUNOXM#f0n>qYPmcrAEvnLAZm4HY9YLQ|8 zo7UX!q8vVY>0AC|kGSirYZuMWD|F?K9|Ub}W|^@v}uh;y`3BaXxPR zvGk@MVS&?MEn8&zcPPm#>?>+yBuOSSB-$k24Gg;sVHl2U=>{d8eygr z*1hW>cSZU}mDO`4VrGIEy)nR$=Ab1w=RcM?qAsJd*m$$}VgP~_>NS54 zq~lx{F{sGOd{|J!!VmUGEM-xxqX1?mhT#-8{RyeV0uOspHAqhSzWYsRdmUnypwLfSdP>qz_iN;e)YlGJ3WNbBvYf~_UIzcGHo}${WO4d@1r<#N8JMdu8;PF={p@6NKO4g)3OMfl>-&v zJvh!a(?Zcv`TK^DWvWnJ=1qn_#?w+0lK2yA*kIZ59p!_>?*MAkK1C!hnqFG<&;au! zU31K-Cco*TbrBfhVv}L=TA!^q*Ml_<8yo~XZkqVzDYQ1>HP!Bm^KCPt2cAyA9Y4AF zUS%FwpbnolU(pe|SRME0N0xz#;~{fKIRWAF6yAd&4T;71L{v`ip7whyLo+g~Lx&jv zD6gKWT8wUKYrcnK5yT0v(*=HC5PtEbWl!oc_sl|R^WnDs@qPnnd~r)VX@4Hn=C~=70;D40i~-{rY5+oN)_2o7&vHLv<>Jn9rS(L}X-NUd*x-=J&0FtX3_~ zJc|Yi<-|-6@GsmD|E!OTX1U!bxkmJu9zDqk0c^8r=$*^^@9%cwAU-6Uf1zXuW~UpM z2#N08Vs&e*<^|xjO!~r6S<3tz%49BAA+{NgsIp|s4z)6Q=3u)es0dnd^58AO0teI= zdLm;q+v~NfUs#CUN#G&))iYrrBWvEEp5zFdO)ZAHb3JrWh!Bq8l}%Zc`|gMA@Gta} zq5xBdsko;fIEx{d z=eHM{5Q@yHx&cA+Xy{d^MEzTasqay#7RJ8bP^uiuLNt*u<^YS3H^M-B7!?H;*E9Vl zs*{7j@{IXZd?$z~WQ$e?rv_tfW<7KMk5+4QJJk*g*>MDG7zUx*TB8G39>xn6j)8TA zyms_dxDrlZ5iM`jIgZG<@Ich$eM9;2AFdSGM(9qk)OAJ2=J4J3159qv_>HKxWM$w! zs4rLjnYz%WLfv0;wm&J^(%DUj`llIZU&INsP&dnQ+)nZN3sfpHFTZn{ z8YFLSxp3;R7*wf_Y75D14?8vnvu(XAzrgu$_q2aL-;zYKE0jdZgV_jqX=&Zg7{&J> z$hlYc=5j0Pa}vpXrBxKlf2$tKLoe=YHSojP&284tUGo_a$&Jk;gvQSp>a|^DD};0> z8N>2wPkz6XK{tJhbhH$@Y>+D`p(mo!Qtj_K@I zV;PYi;LY9m5Pd zKl^eSl)zBZxyEuRvO{6eVD3wZOakyrlW~yVIEQE>Iar#R!fNGwRN|SohMyBe8J^iF zUVpax=~Wl$HOiEw?~vpUkGzu9ohJ&9De$Kn_=95Oa(~pnDFv=ZReZXFW8)lv1$_rW zn&F1#w$~AbZav$t^UK1y=KJB!^%aFX=+(mv45QX{MI!&c1}LW6y1MRdtb$Z^R4X^{ zCZ3BlvJ%m?2V<-JnkJH>O^NOSVgY1u59TIHJfig+beoEC$0v9i146Z(R7ttnS4r1( z$W0a1xZbcXQN+YUlef({&k@HvK-hxYF66c^(dH}?6!a`TyP=!)W9kmil$F^H_A{4K zU>gx7t~Ziijrou-hcIQ65r5ts{HKxO^DO@vHT(@?thQz>wYJ%T@^&ha*UiXEh!ysV zRN=Wn_GfVGz;RzUoUZ-?YacfpODa?gbG>J&d!6rQ&Y%*CFh(V+)gHESQvXU0z}68` zW4W{F#~sMUhbwAp&EFlzAIsnuKpAIY2i3TI2-xaV+JvCQgIvO`n1bq33qsM22xhPe zy)L#*d&q+*n(Ug=4D+}$$i!ey5n=B-EHL^+pCtbL+c+esqMtgL+G!`|&lJM_xwHEz z<2M?=aN1`aT0BC5qo^VcKZdJvF%hFjy#dF}TaFQmbXFPx(Hmrbh{|#uB?xoxuYai% zh;o97Ve!h-g~mDETo~^JM2{v>Tmh)oh5<1N%b@r7SgC=hPkzzFK?d;TtKJvnD<7JTo4z;bTN-W(hOb_I70YbN>Q0o2o82if7pS8*kBiN!x-FsqI2>I5 zTnLdrnzE?O^=AJxja&~q^5B{mdUcY5O6c*JovtST0sr3dE*sFSCNE6t-gMgF*>_da z6G_&!iMU2j(D`bqGmNL42zje2uMe#gk+D7p7Y$bhUmSWik)(8lY^^~^RSc=DvRT8# zEs;;Oqg7s<0|aE7?XeERTeS8h;%ZsGA|srqy6_!h#7?U6Zr=}?f7OJ;EZQg;yU-us z;)V%S2SbSeVMR|WAoIjGSkEXapI^;by+1$;frkGT_B%JW=^z}+#TIQ<8*9nKCKW5J zW;2XVXQIB>tE0{Fs4eUAHsI1Ey%uyx4CPJ_<#+S1Q5z~$jIJ(-LqBuoIl;}r4j^IF4cXPJP0y&Sb|pOE5+sTCtxgl0ov_LY9%G#+h1oK=y+Z?{Ii zE4QzY3~Jz>q6D*RDw=;1^wDhUlc7KvfA z3uC`-T0wY^F3LGp8aTU6-SsCJXJrSC%f*q%Na1U2+>WIf`K4S<5kt2)Om47Pb7cF? z#ae72n0gz3d;cE;D00F1OUtJL523CFyR;!@533ymiu9SUr0{zzzF ze=k;RA-lDP4I&Vb5-$;7IU7WJMR<~mPQ2Urg2L%zVMN74FGdB${r&f5u#^6v%j{DK zw=lfP)!N5}WP*V1{9Oc)hm@bc+iz(d`u@w4FBD@TApcoHBz>u;Q&bXpDr=wte)E+^ z6{nN&U$Y_+_MeIf@a*y4;MZI_8@nbg4e}C(Cbt!KgSl;P79QcJk*@VjT$jOLKxCK6 z+H9*l=WQ0=GCI5nBq?>%JoE)L^pwYYu52bUPSvYrv#$jLyS=2+a!Gj>{eFHuBnh0> zR?U&@A*a-w#_0V?2%m93rK-;qyJ$pog>m(n4Isay42Jn|aCebnFymPSe{X+prBmO2 zljO|N9BRiWl^DG;>{b@d)6KYVIoJENz7(6waPZE%7>w~fmlKkI#b#k)$kL)YNS<*Y zT4H~HGyUgF_len*E|&Xxpcef_ty~cME^33covcD?beSuIG6(|%ue z7!j9OBn1EC59D0r+BwJ`8!Dqn3l~)-D6eWd7uKx$QD&SbNotq8&>8ltr55h+vMX#E zRykomRc{CsEL@Vg>s2;BO?X86RnwoN4_M_k9x8}9{1qPI=}h|8Flcrk%|i~NSz56H z&uz!nQ2uEdD5CfJWG(Zqe?3Ms-Z)HpvSRav>r-i2M12)YT)lvJS13JBeuL4|qS@=d zpx3PYG@Lf~-Co0A?5c+ge;ld{TzV&Ek!ilaQp?k@^ItC`%?ixFBYmbcrDFr4wW8(J zud4ENaSmOgp3P^@(h&6y)4_FubO^isrmN!;dwzQ5Zmm}OQfzTUm;I>qwBdLdzuW5tcxQAPG2}hO~l3v(__GbOKh$+)C}6 z|Ftmmrmyf+2u0QRQkS;5h76&FEGSr<2Nx@Z{6-5=)V2|_YbY!GR%7LriF%LN)U*T| zB-wG@E?kI0A#xsyLuc0Me!A%~AwriU-?mKeA{7hwE55a3}9wz%q?K$VbV!0xqvg%x~dNh-r(jwn_S;vl)I>grzu5aS?q$PyDy z$pRgxp9GH6tp3(@YxHv-#J}VUqM9L6fZR5r5hBfQ4`Z}3I>4oLBPE1GCZ+DbFMbtz zah6rg!1r`3JeJ&GG(X4XfYNm61%1+ckydfu>S3UlUCGTw%88TKE)lcMm`px^A?K!D zYT=w3%5oH1Ni%R#2|Ta-5=Hu@Hn=_mPmRrir0?zd?d_<$GWFvE7M$ifeHx(VGn!u+ zi7=RtIP4aKTQ~l>jhlUws~^V5Y|cAbn0kc&hs@XQB8MC(rib=6f8>DcWXlFPi9{g7 z%BQV!ftX$-wBiH_gfSYQNGa?1UZYpqLDa(h|CY;((MQenfc4%3+ay3=)xyA7`$f@a%^_OZT;S4X5gX))9yuOhHV%3i|C-~5 zNTCL%gG%w(YY@KpCsNi-dDi1{{q~o7U)UZ0x6{u!-utfT@?#Z8YC%;GRx^zKH#XH^7kKAt;y3sBMnE3^t)1VE?60i!?u0?KTd>N=r){Ej0ht5TbW4ww=M3a2!AOW+HELcR~@18Y1Yn zS!l2EZ{2r7vJ^_AY*ckkaPr>MT;T&N8YW89B)VlWN;pKFDRjNrwJ$jK8riReaC0Sa ziKtk+pA-!5!;40*5xhicxs-}_8ymqKsO=S7)3`%c30lToIV)9jUzSBW+8=R}=26Zl-uQEszJZN9W$jm190=&Nypf}4I>pEB$AxS8QF9|M{oL6SpQ4f(T^M>8e zk1KI?j?mg4LMX*oU7V-c&~&tsTrNLc$d<+H)Rzf|?X5YN(e3zT)1a1QG;XeUEa~=# z7xAzaF6(9*ImJU}tWLbVLJGEmSR z_D8!j&>OR-3j$b2m!c4qwl@L&s2CgJtcpEkXnmkT65;&e@U9AgTA#MLMe|TbdROzM zrT9!TCAc`srmEI;%KPlC=d|0+6E=l;rRnrhh^hr`u+w}FyJ`DC&njO0uld0p6HLBU zAvltTrmegu!0=#=w&QV9i{!S!!^Nb>fBeyk=QmKe8XOUxoD?mvV5(Yyb@{mR;_lE> z!3WfU>Ij{`Hn9avwTq+lxb+9jA4e_t+-Kx0%$?1wY3HIdM|C^f{hy}Nn_p{T4_hB+ ziZ}k%>97ZaqBDY-)}PyC(A0cmiQLua(cn^xte&IFi|vO{Rh+QwGI=m3rT6Uq!ttK` zSBdqlnh()`d0Hz4T~&&-P@GyD$ww*Q)Kr+Iia^K|7)?feeMcxxa&0P&@DaQAy3fZ{ z9f5Z;OMKGgHY!vU%%wx9VPO6FyUqT;3Tw{y!iLjx2=GN^-@Z=BHOoeKh<}ZnN#tL9 z{qe1eC!oyF+XZ|_cR)sPtp99FOH{^41J1%i!~Pt;q2jqUA{PC=8oo(-|F<2jr=eXh zu0q@$BdJD;Z5LLy8c0BOk~FOK^LKlZJyM-MI$oaMnH2NzOul`At;G~#qZ{FpB)G{{%C#g7Eb%Pkou|h zwCdv3&FC;qA|7<-qaCfMM@dv)gQYZNk>L3(5UDvrSavUq^NH}>lbYp~%lfh_aNJ)@ zk>x|88(NACk5u3&SjqAF)PtIKm=Y)IixeDM3kRRY){${eb(-LD^R$h=&p2%+LyWEu zW?b`W7sjJxmqo)_Gc#DT98dG2$cH5V5mpj{b0K})^ZC_g4MVWg5MC)oK2SXDLjWgH zs<-Zgw=uu0_yDQBV3&r(yuor zSP?AzENfksPL89H@R5=83)vYK)*tZ+(i09?LirnvNZax8q_Q-x(+)DDYwk|teGVV9 z4_YzAwI*>%-2yp?i<3ze6i$#Dk;H-T0$V7(_jfMiATs4)HN#3h7I=0=A|?kCI~q%6 zreW0Vl|bSi(21pZ5!B{96Sy>)nsw%I6v1Hd{*dGPQ1R@6dv{oWx%$3e9-eMxH6(y@ zE{sn0EE+A*A=N=9?3_m-2rKN2p6ExD>GPYt?BeVza%Wu2F>!QHXTsN@s-3$cO$YY#s`!m?wbDEXGu2 zO3U9P@or&tVZ@73P}W`=JMW7FP#utg!+OMz8{vT6rCS}nNDEZjP6Flg`5Ke-$8VYe z8Bn6*qHxYTZ8skyKuoiLB>TVJq6lP|v?}(eEm{IOw_5U~S7KXA27hR%5X%UGN?n*D zc3en(h-fIuZLM{pi1gkGJTF?3Jrb;403-BOKY`X2Dy!hc6c&g_;eiOO18 sS%oC3KFoeo0ICH4e~MAg;0H8R!JP_dagqsmmIp#cLP5Mr)FANx0Ysb^=Kufz literal 0 HcmV?d00001 diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 00000000..0f3cf1bd --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,183 @@ +#!/usr/bin/env python3 +# -*- coding: utf-8 -*- +# +# Pyrogram documentation build configuration file, created by +# sphinx-quickstart on Fri Dec 29 11:35:55 2017. +# +# This file is execfile()d with the current directory set to its +# containing dir. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +# 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 +# documentation root, use os.path.abspath to make it absolute, like shown here. +# +import os +import sys + +sys.path.insert(0, os.path.abspath('../..')) + +# Import after sys.path.insert() to avoid issues +from pyrogram import __version__ + +# -- General configuration ------------------------------------------------ + +# If your documentation needs a minimal Sphinx version, state it here. +# +# needs_sphinx = '1.0' + +# 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.napoleon' +] + +# Order by source, not alphabetically +autodoc_member_order = 'bysource' + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix(es) of source filenames. +# You can specify multiple suffix as a list of string: +# +# source_suffix = ['.rst', '.md'] +source_suffix = '.rst' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = 'Pyrogram' +copyright = '2017, Dan Tès' +author = 'Dan Tès' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +version = "version " + __version__ +# The full version, including alpha/beta/rc tags. +release = version + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +# +# This is also used if you do content translation via gettext catalogs. +# Usually you set "language" from the command line for these cases. +language = None + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This patterns also effect to html_static_path and html_extra_path +exclude_patterns = [] + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'sphinx' + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = False + +# -- Options for HTML output ---------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +# +html_theme = 'sphinx_rtd_theme' + +html_theme_options = { + 'collapse_navigation': 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 +# documentation. +# +# html_theme_options = {} + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +html_logo = '_static/pyrogram.png' + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +html_favicon = '_static/pyrogram.ico' + +# Add any paths that contain custom static files (such as style sheets) here, +# relative to this directory. They are copied after the builtin static files, +# so a file named "default.css" will overwrite the builtin "default.css". +html_static_path = ['_static'] + +# Custom sidebar templates, must be a dictionary that maps document names +# to template names. +# +# This is required for the alabaster theme +# refs: http://alabaster.readthedocs.io/en/latest/installation.html#sidebars +html_sidebars = { + '**': [ + 'relations.html', # needs 'show_related': True theme option to display + 'searchbox.html', + ] +} + +# -- Options for HTMLHelp output ------------------------------------------ + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Pyrogramdoc' + +# -- Options for LaTeX output --------------------------------------------- + +latex_elements = { + # The paper size ('letterpaper' or 'a4paper'). + # + # 'papersize': 'letterpaper', + + # The font size ('10pt', '11pt' or '12pt'). + # + # 'pointsize': '10pt', + + # Additional stuff for the LaTeX preamble. + # + # 'preamble': '', + + # Latex figure (float) alignment + # + # 'figure_align': 'htbp', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, +# author, documentclass [howto, manual, or own class]). +latex_documents = [ + (master_doc, 'Pyrogram.tex', 'Pyrogram Documentation', + 'Dan Tès', 'manual'), +] + +# -- Options for manual page output --------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + (master_doc, 'pyrogram', 'Pyrogram Documentation', + [author], 1) +] + +# -- Options for Texinfo output ------------------------------------------- + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + (master_doc, 'Pyrogram', 'Pyrogram Documentation', + author, 'Pyrogram', 'One line description of project.', + 'Miscellaneous'), +] diff --git a/docs/source/errors/303_see_other.rst b/docs/source/errors/303_see_other.rst new file mode 100644 index 00000000..6d2875c3 --- /dev/null +++ b/docs/source/errors/303_see_other.rst @@ -0,0 +1,6 @@ +See Other +========= + +.. automodule:: pyrogram.api.errors.exceptions.see_other_303 + :members: + :show-inheritance: diff --git a/docs/source/errors/400_bad_request.rst b/docs/source/errors/400_bad_request.rst new file mode 100644 index 00000000..f10b70dc --- /dev/null +++ b/docs/source/errors/400_bad_request.rst @@ -0,0 +1,6 @@ +Bad Request +=========== + +.. automodule:: pyrogram.api.errors.exceptions.bad_request_400 + :members: + :show-inheritance: diff --git a/docs/source/errors/401_unauthorized.rst b/docs/source/errors/401_unauthorized.rst new file mode 100644 index 00000000..ef73e75b --- /dev/null +++ b/docs/source/errors/401_unauthorized.rst @@ -0,0 +1,6 @@ +Unauthorized +============ + +.. automodule:: pyrogram.api.errors.exceptions.unauthorized_401 + :members: + :show-inheritance: diff --git a/docs/source/errors/420_flood.rst b/docs/source/errors/420_flood.rst new file mode 100644 index 00000000..89b3b713 --- /dev/null +++ b/docs/source/errors/420_flood.rst @@ -0,0 +1,6 @@ +Flood +===== + +.. automodule:: pyrogram.api.errors.exceptions.flood_420 + :members: + :show-inheritance: diff --git a/docs/source/errors/500_internal_server_error.rst b/docs/source/errors/500_internal_server_error.rst new file mode 100644 index 00000000..5fdb1d48 --- /dev/null +++ b/docs/source/errors/500_internal_server_error.rst @@ -0,0 +1,6 @@ +Internal Server Error +===================== + +.. automodule:: pyrogram.api.errors.exceptions.internal_server_error_500 + :members: + :show-inheritance: diff --git a/docs/source/errors/520_unknown_error.rst b/docs/source/errors/520_unknown_error.rst new file mode 100644 index 00000000..e617777d --- /dev/null +++ b/docs/source/errors/520_unknown_error.rst @@ -0,0 +1,6 @@ +Unknown Error +============= + +.. autoclass:: pyrogram.api.errors.error.UnknownError + :members: + :show-inheritance: diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 00000000..b736635c --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,26 @@ +Welcome to Pyrogram +=================== + +.. raw:: html + +

+ +
Pyrogram Icon
+ +

+ +Welcome to Pyrogram's documentation. Here you can find a detailed description of the Pyrogram API. +You will notice that methods are named after the well established `Telegram Bot API`_ and that most of them +accept the same parameters as well. + +.. note:: + This document is intended to be used as an API reference documentation. + For more information on how to install and setup the library, please refer to the Wiki_. + +.. toctree:: + pyrogram + :caption: Documentation + +.. _Wiki: https://github.com/pyrogram/pyrogram/wiki + +.. _`Telegram Bot API`: https://core.telegram.org/bots/api#available-methods \ No newline at end of file diff --git a/docs/source/pyrogram.ChatAction.rst b/docs/source/pyrogram.ChatAction.rst new file mode 100644 index 00000000..750c725f --- /dev/null +++ b/docs/source/pyrogram.ChatAction.rst @@ -0,0 +1,6 @@ +pyrogram.ChatAction +=================== + +.. autoclass:: pyrogram.ChatAction + :members: + :undoc-members: diff --git a/docs/source/pyrogram.Client.rst b/docs/source/pyrogram.Client.rst new file mode 100644 index 00000000..a7e395f5 --- /dev/null +++ b/docs/source/pyrogram.Client.rst @@ -0,0 +1,5 @@ +pyrogram.Client +=============== + +.. autoclass:: pyrogram.Client + :members: diff --git a/docs/source/pyrogram.Error.rst b/docs/source/pyrogram.Error.rst new file mode 100644 index 00000000..57529f8b --- /dev/null +++ b/docs/source/pyrogram.Error.rst @@ -0,0 +1,14 @@ +pyrogram.Error +=============== + +.. autoclass:: pyrogram.Error + :members: + :show-inheritance: + +.. toctree:: + errors/303_see_other + errors/400_bad_request + errors/401_unauthorized + errors/420_flood + errors/500_internal_server_error + errors/520_unknown_error diff --git a/docs/source/pyrogram.rst b/docs/source/pyrogram.rst new file mode 100644 index 00000000..fdeafee4 --- /dev/null +++ b/docs/source/pyrogram.rst @@ -0,0 +1,7 @@ +Pyrogram Package +================ + +.. toctree:: + pyrogram.Client + pyrogram.ChatAction + pyrogram.Error