From 1e632d5f10de36473a1eb4656023696b12a13e4b Mon Sep 17 00:00:00 2001 From: yanyongyu Date: Tue, 30 Jun 2020 12:10:57 +0800 Subject: [PATCH] add autodoc support --- README.md | 4 +- docs/.vuepress/config.js | 38 +++ docs/.vuepress/enhanceApp.js | 14 + docs/.vuepress/public/logo.png | Bin 0 -> 9052 bytes docs/.vuepress/styles/index.styl | 8 + docs/.vuepress/styles/palette.styl | 10 + docs/README.md | 15 + docs_build/Makefile | 20 ++ docs_build/api.rst | 64 ++++ docs_build/conf.py | 78 +++++ docs_build/make.bat | 35 ++ package.json | 31 ++ poetry.lock | 504 ++++++++++++++++++++++++++++- pyproject.toml | 1 + 14 files changed, 817 insertions(+), 5 deletions(-) create mode 100644 docs/.vuepress/config.js create mode 100644 docs/.vuepress/enhanceApp.js create mode 100644 docs/.vuepress/public/logo.png create mode 100644 docs/.vuepress/styles/index.styl create mode 100644 docs/.vuepress/styles/palette.styl create mode 100644 docs/README.md create mode 100644 docs_build/Makefile create mode 100644 docs_build/api.rst create mode 100644 docs_build/conf.py create mode 100644 docs_build/make.bat create mode 100644 package.json diff --git a/README.md b/README.md index 44efb87a..28972878 100644 --- a/README.md +++ b/README.md @@ -11,11 +11,11 @@ ## 简介 -NoneBot 是一个基于 [酷Q](https://cqp.cc/) 的 Python 异步 QQ 机器人框架，它会对 QQ 机器人收到的消息进行解析和处理，并以插件化的形式，分发给消息所对应的命令处理器和自然语言处理器，来完成具体的功能。 +NoneBot 是一个基于 [酷 Q](https://cqp.cc/) 的 Python 异步 QQ 机器人框架，它会对 QQ 机器人收到的消息进行解析和处理，并以插件化的形式，分发给消息所对应的命令处理器和自然语言处理器，来完成具体的功能。 除了起到解析消息的作用，NoneBot 还为插件提供了大量实用的预设操作和权限控制机制，尤其对于命令处理器，它更是提供了完善且易用的会话机制和内部调用机制，以分别适应命令的连续交互和插件内部功能复用等需求。 -NoneBot 在其底层与 酷Q 交互的部分使用 [python-aiocqhttp](https://github.com/richardchien/python-aiocqhttp) 库，后者是 [CQHTTP 插件](https://cqhttp.cc/) 的一个 Python 异步 SDK，在 [Quart](https://pgjones.gitlab.io/quart/) 的基础上封装了与 CQHTTP 插件的网络交互。 +NoneBot 在其底层与 酷 Q 交互的部分使用 [python-aiocqhttp](https://github.com/richardchien/python-aiocqhttp) 库，后者是 [CQHTTP 插件](https://cqhttp.cc/) 的一个 Python 异步 SDK，在 [Quart](https://pgjones.gitlab.io/quart/) 的基础上封装了与 CQHTTP 插件的网络交互。 得益于 Python 的 [asyncio](https://docs.python.org/3/library/asyncio.html) 机制，NoneBot 处理消息的吞吐量有了很大的保障，再配合 CQHTTP 插件可选的 WebSocket 通信方式（也是最建议的通信方式），NoneBot 的性能可以达到 HTTP 通信方式的两倍以上，相较于传统同步 I/O 的 HTTP 通信，更是有质的飞跃。 diff --git a/docs/.vuepress/config.js b/docs/.vuepress/config.js new file mode 100644 index 00000000..eff26981 --- /dev/null +++ b/docs/.vuepress/config.js @@ -0,0 +1,38 @@ +module.exports = { + title: "NoneBot", + description: "基于 酷Q 的 Python 异步 QQ 机器人框架", + markdown: { + lineNumbers: true + }, + /** + * Extra tags to be injected to the page HTML `` + * + * ref：https://v1.vuepress.vuejs.org/config/#head + */ + head: [ + ["link", { rel: "icon", href: "/logo.png" }], + ["meta", { name: "theme-color", content: "#d32f2f" }], + ["meta", { name: "application-name", content: "NoneBot" }], + ["meta", { name: "apple-mobile-web-app-title", content: "NoneBot" }], + ["meta", { name: "apple-mobile-web-app-capable", content: "yes" }], + [ + "meta", + { name: "apple-mobile-web-app-status-bar-style", content: "black" } + ] + ], + + themeConfig: { + repo: "nonebot/nonebot", + editLinks: true, + editLinkText: "在 GitHub 上编辑此页", + docsDir: "docs", + lastUpdated: "上次更新", + nav: [{ text: "API", link: "/api.md" }], + sidebar: {} + }, + + /** + * Apply plugins，ref：https://v1.vuepress.vuejs.org/zh/plugin/ + */ + plugins: ["@vuepress/plugin-back-to-top", "@vuepress/plugin-medium-zoom"] +}; diff --git a/docs/.vuepress/enhanceApp.js b/docs/.vuepress/enhanceApp.js new file mode 100644 index 00000000..8452a868 --- /dev/null +++ b/docs/.vuepress/enhanceApp.js @@ -0,0 +1,14 @@ +/** + * Client app enhancement file. + * + * https://v1.vuepress.vuejs.org/guide/basic-config.html#app-level-enhancements + */ + +export default ({ + Vue, // the version of Vue being used in the VuePress app + options, // the options for the root Vue instance + router, // the router instance for the app + siteData // site metadata +}) => { + // ...apply enhancements for the site. +} diff --git a/docs/.vuepress/public/logo.png b/docs/.vuepress/public/logo.png new file mode 100644 index 0000000000000000000000000000000000000000..45857adacc0b9c5590375712bb5038d87ebfcc32 GIT binary patch literal 9052 zcmcI~i9b}||NlkVvLwr7FTxukm9Z~r>?F(3Bzqz<$TD^#D!XLMzGdH+B8-tNN%lR) z*mov7gYmn4et*OFJ|6R!$9|GxgU-?+-pca<6j+BBCQ7#LAs;v;7QFUk6Gt(EDFJ}v6S(O5#M+yVY%WyYsW zsc_ulwE8fJL;+6ye|vGoG1~WMrt7Tj`x~U2>AsXxx*}|DslBFt@D1~Xg>k;tIH`Z3 z_DRycQG2M;C~pul5PI?K?5Oi1jaX@Lez83kgyS5=6Lwb#DAHN}@oCq}-rBIT4<9h_ zSfD$L-#X@+2STZYM8Lxh&C8T}Mpy7`K`ka(D0o}Y*T+dmNfGn?*IhM_f&D*iBO@sy zC+6X_4Mc@<(Z#PqTfFD~#UIZ$9MQX`@B@4?iNLD^5kFfu161rwwo0_mo$uS3!>0~L zP{vamr@9|{4vbH1pys69Oz{gRg(VC9L{m6vw72-Aw|Ms~UT?}0cZQEDoHp`J*ZYBG zKgUGO2SClSUt@z}4~TecL6Q=D2z!uoJLqC%zQfYr50HWK8fqH^kA?IR{jAZ2xt;u=wy@fe>Pq)pYUKAEyG&%cN=M7mV&63Hm#kp>*?M=v%>=?Biq)N67 z+VB&SEePkVtG$EBb7sj>CeGE8&>-a`dKZ4n=h zQRMJ=Y-Gkxp67Y=gMqS3jIBo|v&vnaRlfAc3p^ix{&K)H|F_**avgitv1-G&?-xNa454o5pn8U3UPM)i8T zEj}6n{$#dGL%-t6QE7yIo2*DrS9(3-%Mopqtz|n>V`-*yD3SoE^oZ20zUA4#HQk4@ z>tWQfZcLo-p4??Ozf)U1Qq$OTw@3F?%>9QHuFn!D)UOQN zzHr@7zy^4KI~4#aeTgiO`Ga3 zCR|~x3xy=@ia;e1kd-^_zNf3&lil!B;;JvAJdms<p$#_bS>m1h0ql*nb(KLe1&?s0)NH*M>jC?N#EK&!-HxuIA+e1O6`^*4>&zkvUy7dHdQAzf zQdD#^^*3l9pS$Yd!k3jQcTX;U%G;-d-ZUml^7(=6;Z~uXq3;V09*5{BRFxJ_Vg>ao zC0IMM_%0R91%EYN5;o6pO?>Hr@_YV+^OZf=4W}bqFeJ2T5oCr*=nKEP*>_*TwahC8 zdd8792cu?KJbKQ-BclLc3h+@?la#Y8m83gsz!l8lRw=m_dzM!kT@Jn`M>9Neb@lr6 z&N9-`+yfmD9;#?PoVKPSb4yAwT7ovIadtcLCF6V%-O^C>~Rt{lA-D(_f7``_tlV%#@^i|;p4Y8&GxhO z4=aD^RX6&VR2G+YMr7QXwdRT>ZPqWB-jDZMT5?EUs?HC}-p%TtO7b@(v`u@7V zDa9UDbg+-^cjfzc-nW=86-?yBj{4TwS!B8z3<(bgD+#(AZ4Q`K2P(}`wpV(6e;6B8 zumr|Ff}1Ge)htc9T{=p*i1?{;q_HKGOI0WAb$x))Qu2$_=K}l}L2>cDQ5TY}?ThUSaMZ_>?&Vln4#O}yx^2ZfTP^A?HtunGa1y zIy1XW-!K1Dcm%Ir4jJAb_3HP!Ga`2w&JgpR0f(RYvq-)P$DsxF*PWn)Z3ZN2A&;O) z<)q)i1h{lI0y#bArSp82`s254m(~X*1e1#*)MYN)yW{8dGTBEx-OHzH`3&!^>RwnR z-BTZEWn!b}F#7(WRAgu6qpT~P7H%6Q^IxQ}B2qU*k%e{kYP|2>>q0n2%nIAxJb1r= zsKClPTcvi?(7Ao&pyaOod{*P555mHUN3S-GTSjD1vBK?<`GUx?g^t~cMxNBdRDYrV z#jU%o1|@0zWiPERE0ZXGX>>#esygg#80*tbe7lPu z%P8hJc@#-E0Il|#Y39l|#%tm_f+1C-f@Yuiea~3YGWq#IMoK zkCyH<^R{&&_B_G%M-V|y4QK3&+9(&;+waH!jz*5WKlQ2i0dpx!mgGHhffu}LZ>^&o zdUidNeq$T|0;}KswyayU`Vvd&=5&H82c6d#4agcRl&bfje)Rz{Bo4lZ5>n&6r4ncS z24qCO7o7EFg~>}%MFa9u1Xs$Uf?DvTo)g1(k<57c5Y@kXGtD(((!u_EtlC>-U`lx!#ly;x z`We$|j>M*-fiKUIIIio>G|3IW1C#=YLUB2qmR1|fz(tTyL4r;FsrNeOzsxY&a(f(? zRg+BY%oBaAh)CVj1GNA<&@zAO)_EF-j8fs`{#ceqab~&i70W|FK)#LVs&0&MDz`M? zxvcEraMDy#sfiwD7+Sp}rnB6GWGDZ0n>O>z1llz7GWspJ!=jlAmuUd`us8NS<*$Ts z5Y|6;|M;g793f0-muBh6`4@q~I*E(=k+fZA87|Jw4LqZbMZl(TF&2fAD}SudDdu#8 z;_vx7{p&}RgKq}yzE<;lH8k;Dot4Mu2`lzgB1Xd^^DeGsDhG8BUO}H1H#t>2w;v{i z(`uM!V28QLtS*ua8#C}f3qrUw3I^l7dp*&BvUtH{DQeB;&?4Zb2v_6s{)fGI;M5dv zC_8fl5_DUHtE7`MMqiGLjBDWZOUdurqm5kp*Ibj-LrhoDABuaMAd>zeYWsBDR5ny{eVa{I+7lR6f-6G`I zoRxhiYn2q-Pbk=Hy7xa6Ha-@Y#AKSTJZ&cDGD}pFZ^6}oX+VvKXLM1@jLNp|fJx;z zqbTkh5=QHHzWeNGiOd0>sI-!#b9mGt96`lL?%I4iWS4*RTQN5}=_S&*;@X+Bfp!0= z&%u(6`+X)J^log}n>1rpe6Z*uX?dk12`PE5}IkMz4=DuP-?+L*9ezde29 zLiM-99__&QBb34PZ`zuAzPnbEYVj^*RqPDe?u5Tm1lLsOOVQgv;~`JKJp$JTT@58E zr6IAxd_acI>Ud4tW?mTGz(4NZd@tQ>6lg3|D!#wX1qo1t*;&mCez~24Wnn`1we)8- zy|-;Gp}J6$utIOANksG@f)CYT?@s?>8;u~@P4nEDmZcm7Zv%Gf;d{V&%~Bg1)UZ*07Xuy2s&BOhoIF{c`Mps-r= z?Dv>yMI^Nf;Tn%|FvmMPng9e$;Th0q)?OY}h$}4U3)8gZ zDO-b}a|HI;H&%IW1GKV#3R+BD{MmIpu3ckA2iA`Kd3Zvv03H+w7(i*5Z>B*=ZpJxH zhluk5AzG_RW`0Qnma)vf+S0H~RySyHa=t7!OfZD& zxlaDK3GS4~EAPiAX^KSoh7PGrSoCYSw~t_#(2c4WqN2y!5t=<6+Z{WIAGyayFyQ*q z`*KBGR)pp$GqJ0Ta{vs9RRXVJn=D2DiH!+(of_*Yl+%=O8O;rbatYi<%yDdvTnIA=6OhUQ@eW{(V@n0AcJI80 zh(NHvVE1Wa*t<{$6%;cumGZfBpvp?WH_-UcFIPX!4J z76SVkeB`a|tuv@}l;HbATp$zEIKB(6>imF2L0dW)!H$ao|BT&Uow*CaI^f>|i zv9vrQoPt!xd$`dqLp|pIn`(gf!|4Fogbo=fgmhlEI>=J{=S+2_mG`lBY^@#xN(~&w z7BR1tG(ZRoV}bzO&(-VCS&8SpRCSM&7}YKTG?+-npA~BV)-T5@kVA1J$9;nFzkE^f z*-XJGGSHaY4<-qDV0_4q1yMnD)BXl$Ndo&QK5{T154P(sTS?T+6D$Wm43K>okfqDg z&msx?X*z);L+1%Aw@u5!H2pNpOVb$FvmzluOkmbjmn!P4M)D1fg<7x>x-^)6?V^~- zvJH;Sd#(|q!s?D5V15(7;aQjfj<@)bSJ+X0rk5Kbzlh(uwm`4ww#pDtkkL011~v_I zVv}Fw1%-#z8Qa$W(D>&hXG#HgIXcg2<9|Dh6;M~hPu2?6a_zujPsLr<>hDN-s)M@? z3_K$8F9YJgp78}Rt>NH~G5(wHF(ox+uDuF!InH1lE11J4IU=O(aLxDXRv@uvW&%_b zAr>j$x2`(f`j>mkb{b=S;hH^@9n>mD3oIkpM-M#hS(ejp0=5Qm_B7}5VIBfG8<#Gr z2#)=(4JB#A8jb$9uP&H<5i^`1U_=P<4JC$de`Evhx@{}S*Ldl`8h2-(4Uwx@tR^ls zy%IjG3G)cmc?vk(+OJIWx%uc}xTeN^iI>GZGc*Pu?8Vg|$n2GbdAQt%CLe5`KZF7A zUJB=PP7+U?nAScu+q)zV@P<>jsxTAB=-qr9P=CotaeCFiL6gbm4Q)|S3d%IR78g^}pI7-(5V)go#mLCMCKss&YgCp?>*ZPfhvk~85k<~QdWwDs5Cfv0D)oJ52?LN!R3FTkhD&SyO2^7RqFAVH`9+;w2SZ6jA& zXRi?>4%`_bXmKo|KMR|{>ShW1Y|my$lsD7Bf}o-pfKOgh>`FX6M@wA?u6Lf!sIOWm z&z6e;rg>szMZmsJfahUq-Y-Q6r0)56u?0wa1G_7A%9Y&thQ>oPzXW?qh^sK-K~z$2 z8YlZC5n(j>(^--9#26r+#GrmGe^7T3Z=zc5KgHeNthzsD%BFTHTZjgyRBT<0Qi+jp z3KxG3KH1LmmMn>+#USg2PwfXS%Tw5i$270&nr!(tPGi$kbHwSUL&@Iwq7$CPx>U)YY$ui};>k8_! zyWkx+xGn3Pwezj1x~RCm{>}C?N@Rt{~c; z8BWa)@~4*Swq+T#iRnt=E`2XAhzthSxA9zs)ygV623;3V>He4NG!e8a^6eR%qfI^nO;0vTimD1l6xH8= z@%ebLY32kD$VrjhM?~)j3p2*enMZR~i4scfZOF;plyx$hyKeV;hlHpQ`FN9j3N9VhdfAka zdvgu#&IV*M&te$eW%AlLf5JAu8iTEwzTey*aUvNo+Lr(Iyw4?f)g1Lf%nZFr`%yOJ zvV4>;p{tj{#EK3%=n|5w!2+-zfMU!k#gF zh`w9Nl&|CRMcz?o}~$6Y-2$~IjLv^aTb<5kGC-}njH znU$wSl0+@vTHcYchNF1?u$$6dPJB=_vI%qd$)OI@x;OOP0RDU?y}J6-nA;+` z6(N`6nNqDRDD;HWZm~Nfog=E)hP86ZtKgWURim%EC%VQCiG#@AT<uLZnv5oSmfE6J|1T8Ej|J( zv`uwrt6#NuJl=Tiw`|7atjcHIEzS3G$?4#E!M}ZVF_E;m6LJ?!T(7U(9nHZsOf{0E zV!WCT63Uf4!(;~F;Whb*QWQSfANP!cU9Pyrd)7H=1S^wEM%R(#RM4|q>gg`$-16U} z4v6dq-_cWJG})~^f1Co8`r@XDhed5~&RCU77AREYrGVN*;b+oMU%3I))L3uNZn>ws zZwEN*rC!gyCtfV9zFlC`9w;lM&sAkI?8kY!ze^n{FQmX&!C*35WRIX0%b+X;r~~KR3NuODXdy(HK*v#^q{l$c>UQ8 zL*mpQ<^dwg6fyJXH5nYy!onK$I&!`*iC0~_A9mTHG(Y$FUY2w3wD5&7D9~m$Gbsq5(=sLELV;}WCw0LU%DOHaDZdLu~mQNSn z9`O`0TLH!_1WfGgta`hsdV8w@hi9;8g!D<2^`yW{5drdeZEtg#R zXNBSHlaD@m`K4($=YUu8M+g=|#_1&nu@vcTsn|tv5m%Mej1(K8=FbdVbuU(aee!~^ z${h3l>Fs1csCQ$m{s~a+#t8Q`MN92TKW%Jdiq5pv!{L6k21(ydZNANWlId0 zjDyZG2%}V?|SM-s1DCOD9gC<3^lA!ts7+7MG0V^LPLeU6*Ls6*#wIhRf~Ra%n08AB7^bX*o3Z3p^{)aX%35k=?XxNc3rAX~IMI z%`qFE=8X2M58z7H5sFZ(8kN={nFLw(73>0y(I(}}9Tj=KVR)8PE(Pv%E7gW7@60*x zY<xaoos?N5UH~#umM5im7;_`n`zc=+7;U2}AUQ!3zta zw0|GYBNrP?s@;+fzKI*T(ot+hi|W@Od;rz+%`Jf%$;;RY@9^85#EjL}IZj;qr=fGL zXdB&X3ViZNX@r8vp1NUda?kLDov5m75!}aJWs8T>D#(T&GkHbHLfoyZX0SC>Zdr+ab@ejw zuq`cNLZiulLG`*puFg7xi?o;Kq9pUdv@Xkl*}` zqP9|252)(donhEW-Z|ljcAU3(IXLeJdmZz@nvMZg)VZ|)$T%E;H4l806!;!O=uGg} zKEgfgK-&C;gtXF_eu_!^-cCao&Ncf%4fRci?|zQuS(4x6!pzH!tqw=H5Te}%P zkdV$#fe=YFKh)8W^L=vN!Qq_X&P0Bod$Q-wAZvl7%*Y^pwt%{xG8F0K_vJ^5 z*Txpb)sU|a+Qy0-$xUUEm7O>Kf;2+h1`snLe8BFN9~{c0vLrUWJVBOHIuzPa`Qox2 z>OFU^Z<@O=(q)H0$ER!^J(Cxe{`7Ly+jJZxBRd`ISK*KQI~B^6cu@frl0~JIsId+* zVgmKA-6LO2z!GP7KtSDtl1G0<8W*JG8n1WtKvOaPXPvd2I7OZi8Ph%T{pnTeXNg7p z)*ACOcD(`3)kqI(-TRGNFQ2|q-lsi-DP)O^#iANgJ*HB?w41TO2bC6~;HYb7 zFUYI?W`HYbHb>o^?PAq3=~+x!zno>H*HP zyqlCY&2|(wZDN!Cn33(pM!&8i+FR+V{LJw*dj_^b$+N3@?bCWJv@o7Hsd3PJvSPC? zPdXh{K3dwb2!vmp<6m6pmY!a3{~axN)FHm_c$N8r>zWKu4jJyx z>$4kNePK)V@k&lxAnu0S+E&`8-1N=ss`I%YwBrn9qoC4Z9U}qeb=XZnReYRUwn3vT)kAS2m3UpPri4Q_xwz#m0N_E&92F znajk~u~Yl&@0|u!r<2B{#6jag1gYhu|9L#e|LtE%K<``y7i39MwtKjeHT8d!X{kMe JRj69M`G4*cmU93A literal 0 HcmV?d00001 diff --git a/docs/.vuepress/styles/index.styl b/docs/.vuepress/styles/index.styl new file mode 100644 index 00000000..420feb93 --- /dev/null +++ b/docs/.vuepress/styles/index.styl @@ -0,0 +1,8 @@ +/** + * Custom Styles here. + * + * ref：https://v1.vuepress.vuejs.org/config/#index-styl + */ + +.home .hero img + max-width 450px!important diff --git a/docs/.vuepress/styles/palette.styl b/docs/.vuepress/styles/palette.styl new file mode 100644 index 00000000..238a5a9f --- /dev/null +++ b/docs/.vuepress/styles/palette.styl @@ -0,0 +1,10 @@ +/** + * Custom palette here. + * + * ref：https://v1.vuepress.vuejs.org/zh/config/#palette-styl + */ + +$accentColor = #d32f2f +$textColor = #2c3e50 +$borderColor = #eaecef +$codeBgColor = #282c34 diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 00000000..e568de9f --- /dev/null +++ b/docs/README.md @@ -0,0 +1,15 @@ +--- +home: true +heroImage: /logo.png +tagline: An asynchronous QQ bot framework. +actionText: 开始使用 +actionLink: /guide/ +features: + - title: 简洁 + details: 提供极其简洁易懂的 API，使你可以毫无压力地开始验证你的绝佳创意，只需编写最少量的代码，即可实现丰富的功能。 + - title: 易于扩展 + details: 精心设计的消息处理流程使得你可以很方便地将原型扩充为具有大量实用功能的完整聊天机器人，并持续保证扩展性。 + - title: 高性能 + details: 采用异步 I/O，利用 WebSocket 进行通信，以获得极高的性能；同时，支持使用多账号同时接入，减少业务宕机的可能。 +footer: MIT Licensed | Copyright © 2020 NoneBot Team +--- diff --git a/docs_build/Makefile b/docs_build/Makefile new file mode 100644 index 00000000..d4bb2cbb --- /dev/null +++ b/docs_build/Makefile @@ -0,0 +1,20 @@ +# Minimal makefile for Sphinx documentation +# + +# You can set these variables from the command line, and also +# from the environment for the first two. +SPHINXOPTS ?= +SPHINXBUILD ?= sphinx-build +SOURCEDIR = . +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) diff --git a/docs_build/api.rst b/docs_build/api.rst new file mode 100644 index 00000000..ec11194d --- /dev/null +++ b/docs_build/api.rst @@ -0,0 +1,64 @@ +nonebot package +=============== + +.. automodule:: nonebot + :members: + :undoc-members: + :show-inheritance: + +nonebot.event module +-------------------- + +.. automodule:: nonebot.event + :members: + :undoc-members: + :show-inheritance: + +nonebot.exception module +------------------------ + +.. automodule:: nonebot.exception + :members: + :undoc-members: + :show-inheritance: + +nonebot.log module +------------------ + +.. automodule:: nonebot.log + :members: + :undoc-members: + :show-inheritance: + +nonebot.matcher module +---------------------- + +.. automodule:: nonebot.matcher + :members: + :undoc-members: + :show-inheritance: + +nonebot.plugin module +--------------------- + +.. automodule:: nonebot.plugin + :members: + :undoc-members: + :show-inheritance: + +nonebot.rule module +------------------- + +.. automodule:: nonebot.rule + :members: + :undoc-members: + :show-inheritance: + +nonebot.typing module +--------------------- + +.. automodule:: nonebot.typing + :members: + :undoc-members: + :show-inheritance: + diff --git a/docs_build/conf.py b/docs_build/conf.py new file mode 100644 index 00000000..bb44132d --- /dev/null +++ b/docs_build/conf.py @@ -0,0 +1,78 @@ +# Configuration file for the Sphinx documentation builder. +# +# This file only contains a selection of the most common options. For a full +# list see the documentation: +# https://www.sphinx-doc.org/en/master/usage/configuration.html + +# -- Path setup -------------------------------------------------------------- + +# 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.join(os.path.abspath(os.path.dirname(os.path.dirname(__file__))), +# "nonebot")) +sys.path.insert(0, os.path.abspath(os.path.dirname(os.path.dirname(__file__)))) + +# -- Project information ----------------------------------------------------- + +project = 'nonebot' +copyright = '2020, richardchien' +author = 'richardchien' + +# The short X.Y version +version = '2.0.0' + +# The full version, including alpha/beta/rc tags +release = '2.0.0' + +# -- General configuration --------------------------------------------------- + +# 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.viewcode', + 'sphinx.ext.todo', +] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# 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 = 'zh' + +master_doc = "api" + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +# This pattern also affects html_static_path and html_extra_path. +exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store'] + +# -- 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 = 'alabaster' + +# 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'] + +# -- Extension configuration ------------------------------------------------- + +# -- Options for todo extension ---------------------------------------------- + +# If true, `todo` and `todoList` produce output, else they produce nothing. +todo_include_todos = True diff --git a/docs_build/make.bat b/docs_build/make.bat new file mode 100644 index 00000000..922152e9 --- /dev/null +++ b/docs_build/make.bat @@ -0,0 +1,35 @@ +@ECHO OFF + +pushd %~dp0 + +REM Command file for Sphinx documentation + +if "%SPHINXBUILD%" == "" ( + set SPHINXBUILD=sphinx-build +) +set SOURCEDIR=. +set BUILDDIR=_build + +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% %O% +goto end + +:help +%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O% + +:end +popd diff --git a/package.json b/package.json new file mode 100644 index 00000000..c2a0698a --- /dev/null +++ b/package.json @@ -0,0 +1,31 @@ +{ + "name": "nonebot", + "version": "2.0.0", + "description": "An asynchronous QQ bot framework.", + "homepage": "https://nonebot.cqp.moe/", + "main": "index.js", + "contributors": [ + { + "name": "Richard Chien", + "email": "richardchienthebest@gmail.com" + }, + { + "name": "yanyongyu", + "email": "yanyongyu_1@126.com" + } + ], + "repository": "https://github.com/nonebot/nonebot/nonebot", + "bugs": { + "url": "https://github.com/nonebot/nonebot/issues" + }, + "scripts": { + "dev": "vuepress dev docs", + "build": "vuepress build docs" + }, + "license": "MIT", + "devDependencies": { + "vuepress": "^1.3.1", + "@vuepress/plugin-back-to-top": "^1.3.1", + "@vuepress/plugin-medium-zoom": "^1.3.1" + } +} diff --git a/poetry.lock b/poetry.lock index cd39545d..15c6f700 100644 --- a/poetry.lock +++ b/poetry.lock @@ -1,3 +1,16 @@ +[[package]] +category = "dev" +description = "A configurable sidebar-enabled Sphinx theme" +name = "alabaster" +optional = false +python-versions = "*" +version = "0.7.12" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + [[package]] category = "main" description = "In-process task scheduler with Cron-like capabilities" @@ -30,11 +43,181 @@ reference = "aliyun" type = "legacy" url = "https://mirrors.aliyun.com/pypi/simple" +[[package]] +category = "dev" +description = "Internationalization utilities" +name = "babel" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" +version = "2.8.0" + +[package.dependencies] +pytz = ">=2015.7" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Python package for providing Mozilla's CA Bundle." +name = "certifi" +optional = false +python-versions = "*" +version = "2020.6.20" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Universal encoding detector for Python 2 and 3" +name = "chardet" +optional = false +python-versions = "*" +version = "3.0.4" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Cross-platform colored terminal text." +marker = "sys_platform == \"win32\"" +name = "colorama" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" +version = "0.4.3" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Docutils -- Python Documentation Utilities" +name = "docutils" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" +version = "0.16" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Internationalized Domain Names in Applications (IDNA)" +name = "idna" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" +version = "2.10" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Getting image size from png/jpeg/jpeg2000/gif file" +name = "imagesize" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" +version = "1.2.0" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "A very fast and expressive template engine." +name = "jinja2" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" +version = "2.11.2" + +[package.dependencies] +MarkupSafe = ">=0.23" + +[package.extras] +i18n = ["Babel (>=0.8)"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Safely add untrusted strings to HTML/XML markup." +name = "markupsafe" +optional = false +python-versions = ">=2.7,!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*" +version = "1.1.1" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Core utilities for Python packages" +name = "packaging" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*" +version = "20.4" + +[package.dependencies] +pyparsing = ">=2.0.2" +six = "*" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Pygments is a syntax highlighting package written in Python." +name = "pygments" +optional = false +python-versions = ">=3.5" +version = "2.6.1" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Python parsing module" +name = "pyparsing" +optional = false +python-versions = ">=2.6, !=3.0.*, !=3.1.*, !=3.2.*" +version = "2.4.7" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + [[package]] category = "main" description = "World timezone definitions, modern and historical" name = "pytz" -optional = true +optional = false python-versions = "*" version = "2020.1" @@ -43,11 +226,34 @@ reference = "aliyun" type = "legacy" url = "https://mirrors.aliyun.com/pypi/simple" +[[package]] +category = "dev" +description = "Python HTTP for Humans." +name = "requests" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*" +version = "2.24.0" + +[package.dependencies] +certifi = ">=2017.4.17" +chardet = ">=3.0.2,<4" +idna = ">=2.5,<3" +urllib3 = ">=1.21.1,<1.25.0 || >1.25.0,<1.25.1 || >1.25.1,<1.26" + +[package.extras] +security = ["pyOpenSSL (>=0.14)", "cryptography (>=1.3.4)"] +socks = ["PySocks (>=1.5.6,<1.5.7 || >1.5.7)", "win-inet-pton"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + [[package]] category = "main" description = "Python 2 and 3 compatibility utilities" name = "six" -optional = true +optional = false python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*" version = "1.15.0" @@ -56,6 +262,157 @@ reference = "aliyun" type = "legacy" url = "https://mirrors.aliyun.com/pypi/simple" +[[package]] +category = "dev" +description = "This package provides 26 stemmers for 25 languages generated from Snowball algorithms." +name = "snowballstemmer" +optional = false +python-versions = "*" +version = "2.0.0" + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "Python documentation generator" +name = "sphinx" +optional = false +python-versions = ">=3.5" +version = "3.1.1" + +[package.dependencies] +Jinja2 = ">=2.3" +Pygments = ">=2.0" +alabaster = ">=0.7,<0.8" +babel = ">=1.3" +colorama = ">=0.3.5" +docutils = ">=0.12" +imagesize = "*" +packaging = "*" +requests = ">=2.5.0" +setuptools = "*" +snowballstemmer = ">=1.1" +sphinxcontrib-applehelp = "*" +sphinxcontrib-devhelp = "*" +sphinxcontrib-htmlhelp = "*" +sphinxcontrib-jsmath = "*" +sphinxcontrib-qthelp = "*" +sphinxcontrib-serializinghtml = "*" + +[package.extras] +docs = ["sphinxcontrib-websupport"] +lint = ["flake8 (>=3.5.0)", "flake8-import-order", "mypy (>=0.780)", "docutils-stubs"] +test = ["pytest", "pytest-cov", "html5lib", "typed-ast", "cython"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "sphinxcontrib-applehelp is a sphinx extension which outputs Apple help books" +name = "sphinxcontrib-applehelp" +optional = false +python-versions = ">=3.5" +version = "1.0.2" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "sphinxcontrib-devhelp is a sphinx extension which outputs Devhelp document." +name = "sphinxcontrib-devhelp" +optional = false +python-versions = ">=3.5" +version = "1.0.2" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "sphinxcontrib-htmlhelp is a sphinx extension which renders HTML help files" +name = "sphinxcontrib-htmlhelp" +optional = false +python-versions = ">=3.5" +version = "1.0.3" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest", "html5lib"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "A sphinx extension which renders display math in HTML via JavaScript" +name = "sphinxcontrib-jsmath" +optional = false +python-versions = ">=3.5" +version = "1.0.1" + +[package.extras] +test = ["pytest", "flake8", "mypy"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "sphinxcontrib-qthelp is a sphinx extension which outputs QtHelp document." +name = "sphinxcontrib-qthelp" +optional = false +python-versions = ">=3.5" +version = "1.0.3" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + +[[package]] +category = "dev" +description = "sphinxcontrib-serializinghtml is a sphinx extension which outputs \"serialized\" HTML files (json and pickle)." +name = "sphinxcontrib-serializinghtml" +optional = false +python-versions = ">=3.5" +version = "1.1.4" + +[package.extras] +lint = ["flake8", "mypy", "docutils-stubs"] +test = ["pytest"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + [[package]] category = "main" description = "tzinfo object for the local timezone" @@ -72,6 +429,24 @@ reference = "aliyun" type = "legacy" url = "https://mirrors.aliyun.com/pypi/simple" +[[package]] +category = "dev" +description = "HTTP library with thread-safe connection pooling, file post, and more." +name = "urllib3" +optional = false +python-versions = ">=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*, !=3.4.*, <4" +version = "1.25.9" + +[package.extras] +brotli = ["brotlipy (>=0.6.0)"] +secure = ["certifi", "cryptography (>=1.3.4)", "idna (>=2.0.0)", "pyOpenSSL (>=0.14)", "ipaddress"] +socks = ["PySocks (>=1.5.6,<1.5.7 || >1.5.7,<2.0)"] + +[package.source] +reference = "aliyun" +type = "legacy" +url = "https://mirrors.aliyun.com/pypi/simple" + [[package]] category = "dev" description = "A formatter for Python code." @@ -89,26 +464,149 @@ url = "https://mirrors.aliyun.com/pypi/simple" scheduler = ["apscheduler"] [metadata] -content-hash = "1cf1db5856a5f3e46484122795ab0da8f579d1ca907ce62b67869f77196f640f" +content-hash = "84f5268c5011bb03aea6f51e16b738a73f18a483b6948ea978b98943002c10bd" python-versions = "^3.7" [metadata.files] +alabaster = [ + {file = "alabaster-0.7.12-py2.py3-none-any.whl", hash = "sha256:446438bdcca0e05bd45ea2de1668c1d9b032e1a9154c2c259092d77031ddd359"}, + {file = "alabaster-0.7.12.tar.gz", hash = "sha256:a661d72d58e6ea8a57f7a86e37d86716863ee5e92788398526d58b26a4e4dc02"}, +] apscheduler = [ {file = "APScheduler-3.6.3-py2.py3-none-any.whl", hash = "sha256:e8b1ecdb4c7cb2818913f766d5898183c7cb8936680710a4d3a966e02262e526"}, {file = "APScheduler-3.6.3.tar.gz", hash = "sha256:3bb5229eed6fbbdafc13ce962712ae66e175aa214c69bed35a06bffcf0c5e244"}, ] +babel = [ + {file = "Babel-2.8.0-py2.py3-none-any.whl", hash = "sha256:d670ea0b10f8b723672d3a6abeb87b565b244da220d76b4dba1b66269ec152d4"}, + {file = "Babel-2.8.0.tar.gz", hash = "sha256:1aac2ae2d0d8ea368fa90906567f5c08463d98ade155c0c4bfedd6a0f7160e38"}, +] +certifi = [ + {file = "certifi-2020.6.20-py2.py3-none-any.whl", hash = "sha256:8fc0819f1f30ba15bdb34cceffb9ef04d99f420f68eb75d901e9560b8749fc41"}, + {file = "certifi-2020.6.20.tar.gz", hash = "sha256:5930595817496dd21bb8dc35dad090f1c2cd0adfaf21204bf6732ca5d8ee34d3"}, +] +chardet = [ + {file = "chardet-3.0.4-py2.py3-none-any.whl", hash = "md5:0004b00caff7bb543a1d0d0bd0185a03"}, + {file = "chardet-3.0.4.tar.gz", hash = "md5:7dd1ba7f9c77e32351b0a0cfacf4055c"}, +] +colorama = [ + {file = "colorama-0.4.3-py2.py3-none-any.whl", hash = "sha256:7d73d2a99753107a36ac6b455ee49046802e59d9d076ef8e47b61499fa29afff"}, + {file = "colorama-0.4.3.tar.gz", hash = "sha256:e96da0d330793e2cb9485e9ddfd918d456036c7149416295932478192f4436a1"}, +] +docutils = [ + {file = "docutils-0.16-py2.py3-none-any.whl", hash = "sha256:0c5b78adfbf7762415433f5515cd5c9e762339e23369dbe8000d84a4bf4ab3af"}, + {file = "docutils-0.16.tar.gz", hash = "sha256:c2de3a60e9e7d07be26b7f2b00ca0309c207e06c100f9cc2a94931fc75a478fc"}, +] +idna = [ + {file = "idna-2.10-py2.py3-none-any.whl", hash = "sha256:b97d804b1e9b523befed77c48dacec60e6dcb0b5391d57af6a65a312a90648c0"}, + {file = "idna-2.10.tar.gz", hash = "sha256:b307872f855b18632ce0c21c5e45be78c0ea7ae4c15c828c20788b26921eb3f6"}, +] +imagesize = [ + {file = "imagesize-1.2.0-py2.py3-none-any.whl", hash = "sha256:6965f19a6a2039c7d48bca7dba2473069ff854c36ae6f19d2cde309d998228a1"}, + {file = "imagesize-1.2.0.tar.gz", hash = "sha256:b1f6b5a4eab1f73479a50fb79fcf729514a900c341d8503d62a62dbc4127a2b1"}, +] +jinja2 = [ + {file = "Jinja2-2.11.2-py2.py3-none-any.whl", hash = "sha256:f0a4641d3cf955324a89c04f3d94663aa4d638abe8f733ecd3582848e1c37035"}, + {file = "Jinja2-2.11.2.tar.gz", hash = "sha256:89aab215427ef59c34ad58735269eb58b1a5808103067f7bb9d5836c651b3bb0"}, +] +markupsafe = [ + {file = "MarkupSafe-1.1.1-cp27-cp27m-macosx_10_6_intel.whl", hash = "sha256:09027a7803a62ca78792ad89403b1b7a73a01c8cb65909cd876f7fcebd79b161"}, + {file = "MarkupSafe-1.1.1-cp27-cp27m-manylinux1_i686.whl", hash = "sha256:e249096428b3ae81b08327a63a485ad0878de3fb939049038579ac0ef61e17e7"}, + {file = "MarkupSafe-1.1.1-cp27-cp27m-manylinux1_x86_64.whl", hash = "sha256:500d4957e52ddc3351cabf489e79c91c17f6e0899158447047588650b5e69183"}, + {file = "MarkupSafe-1.1.1-cp27-cp27m-win32.whl", hash = "sha256:b2051432115498d3562c084a49bba65d97cf251f5a331c64a12ee7e04dacc51b"}, + {file = "MarkupSafe-1.1.1-cp27-cp27m-win_amd64.whl", hash = "sha256:98c7086708b163d425c67c7a91bad6e466bb99d797aa64f965e9d25c12111a5e"}, + {file = "MarkupSafe-1.1.1-cp27-cp27mu-manylinux1_i686.whl", hash = "sha256:cd5df75523866410809ca100dc9681e301e3c27567cf498077e8551b6d20e42f"}, + {file = "MarkupSafe-1.1.1-cp27-cp27mu-manylinux1_x86_64.whl", hash = "sha256:43a55c2930bbc139570ac2452adf3d70cdbb3cfe5912c71cdce1c2c6bbd9c5d1"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-macosx_10_6_intel.whl", hash = "sha256:1027c282dad077d0bae18be6794e6b6b8c91d58ed8a8d89a89d59693b9131db5"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-manylinux1_i686.whl", hash = "sha256:62fe6c95e3ec8a7fad637b7f3d372c15ec1caa01ab47926cfdf7a75b40e0eac1"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-manylinux1_x86_64.whl", hash = "sha256:88e5fcfb52ee7b911e8bb6d6aa2fd21fbecc674eadd44118a9cc3863f938e735"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-win32.whl", hash = "sha256:ade5e387d2ad0d7ebf59146cc00c8044acbd863725f887353a10df825fc8ae21"}, + {file = "MarkupSafe-1.1.1-cp34-cp34m-win_amd64.whl", hash = "sha256:09c4b7f37d6c648cb13f9230d847adf22f8171b1ccc4d5682398e77f40309235"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-macosx_10_6_intel.whl", hash = "sha256:79855e1c5b8da654cf486b830bd42c06e8780cea587384cf6545b7d9ac013a0b"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-manylinux1_i686.whl", hash = "sha256:c8716a48d94b06bb3b2524c2b77e055fb313aeb4ea620c8dd03a105574ba704f"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-manylinux1_x86_64.whl", hash = "sha256:7c1699dfe0cf8ff607dbdcc1e9b9af1755371f92a68f706051cc8c37d447c905"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-win32.whl", hash = "sha256:6dd73240d2af64df90aa7c4e7481e23825ea70af4b4922f8ede5b9e35f78a3b1"}, + {file = "MarkupSafe-1.1.1-cp35-cp35m-win_amd64.whl", hash = "sha256:9add70b36c5666a2ed02b43b335fe19002ee5235efd4b8a89bfcf9005bebac0d"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-macosx_10_6_intel.whl", hash = "sha256:24982cc2533820871eba85ba648cd53d8623687ff11cbb805be4ff7b4c971aff"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-manylinux1_i686.whl", hash = "sha256:00bc623926325b26bb9605ae9eae8a215691f33cae5df11ca5424f06f2d1f473"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-manylinux1_x86_64.whl", hash = "sha256:717ba8fe3ae9cc0006d7c451f0bb265ee07739daf76355d06366154ee68d221e"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-win32.whl", hash = "sha256:535f6fc4d397c1563d08b88e485c3496cf5784e927af890fb3c3aac7f933ec66"}, + {file = "MarkupSafe-1.1.1-cp36-cp36m-win_amd64.whl", hash = "sha256:b1282f8c00509d99fef04d8ba936b156d419be841854fe901d8ae224c59f0be5"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-macosx_10_6_intel.whl", hash = "sha256:8defac2f2ccd6805ebf65f5eeb132adcf2ab57aa11fdf4c0dd5169a004710e7d"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-manylinux1_i686.whl", hash = "sha256:46c99d2de99945ec5cb54f23c8cd5689f6d7177305ebff350a58ce5f8de1669e"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-manylinux1_x86_64.whl", hash = "sha256:ba59edeaa2fc6114428f1637ffff42da1e311e29382d81b339c1817d37ec93c6"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-win32.whl", hash = "sha256:b00c1de48212e4cc9603895652c5c410df699856a2853135b3967591e4beebc2"}, + {file = "MarkupSafe-1.1.1-cp37-cp37m-win_amd64.whl", hash = "sha256:9bf40443012702a1d2070043cb6291650a0841ece432556f784f004937f0f32c"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-macosx_10_9_x86_64.whl", hash = "sha256:6788b695d50a51edb699cb55e35487e430fa21f1ed838122d722e0ff0ac5ba15"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-manylinux1_i686.whl", hash = "sha256:cdb132fc825c38e1aeec2c8aa9338310d29d337bebbd7baa06889d09a60a1fa2"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-manylinux1_x86_64.whl", hash = "sha256:13d3144e1e340870b25e7b10b98d779608c02016d5184cfb9927a9f10c689f42"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-win32.whl", hash = "sha256:596510de112c685489095da617b5bcbbac7dd6384aeebeda4df6025d0256a81b"}, + {file = "MarkupSafe-1.1.1-cp38-cp38-win_amd64.whl", hash = "sha256:e8313f01ba26fbbe36c7be1966a7b7424942f670f38e666995b88d012765b9be"}, + {file = "MarkupSafe-1.1.1.tar.gz", hash = "sha256:29872e92839765e546828bb7754a68c418d927cd064fd4708fab9fe9c8bb116b"}, +] +packaging = [ + {file = "packaging-20.4-py2.py3-none-any.whl", hash = "sha256:998416ba6962ae7fbd6596850b80e17859a5753ba17c32284f67bfff33784181"}, + {file = "packaging-20.4.tar.gz", hash = "sha256:4357f74f47b9c12db93624a82154e9b120fa8293699949152b22065d556079f8"}, +] +pygments = [ + {file = "Pygments-2.6.1-py3-none-any.whl", hash = "sha256:ff7a40b4860b727ab48fad6360eb351cc1b33cbf9b15a0f689ca5353e9463324"}, + {file = "Pygments-2.6.1.tar.gz", hash = "sha256:647344a061c249a3b74e230c739f434d7ea4d8b1d5f3721bc0f3558049b38f44"}, +] +pyparsing = [ + {file = "pyparsing-2.4.7-py2.py3-none-any.whl", hash = "sha256:ef9d7589ef3c200abe66653d3f1ab1033c3c419ae9b9bdb1240a85b024efc88b"}, + {file = "pyparsing-2.4.7.tar.gz", hash = "sha256:c203ec8783bf771a155b207279b9bccb8dea02d8f0c9e5f8ead507bc3246ecc1"}, +] pytz = [ {file = "pytz-2020.1-py2.py3-none-any.whl", hash = "sha256:a494d53b6d39c3c6e44c3bec237336e14305e4f29bbf800b599253057fbb79ed"}, {file = "pytz-2020.1.tar.gz", hash = "sha256:c35965d010ce31b23eeb663ed3cc8c906275d6be1a34393a1d73a41febf4a048"}, ] +requests = [ + {file = "requests-2.24.0-py2.py3-none-any.whl", hash = "sha256:fe75cc94a9443b9246fc7049224f75604b113c36acb93f87b80ed42c44cbb898"}, + {file = "requests-2.24.0.tar.gz", hash = "sha256:b3559a131db72c33ee969480840fff4bb6dd111de7dd27c8ee1f820f4f00231b"}, +] six = [ {file = "six-1.15.0-py2.py3-none-any.whl", hash = "sha256:8b74bedcbbbaca38ff6d7491d76f2b06b3592611af620f8426e82dddb04a5ced"}, {file = "six-1.15.0.tar.gz", hash = "sha256:30639c035cdb23534cd4aa2dd52c3bf48f06e5f4a941509c8bafd8ce11080259"}, ] +snowballstemmer = [ + {file = "snowballstemmer-2.0.0-py2.py3-none-any.whl", hash = "sha256:209f257d7533fdb3cb73bdbd24f436239ca3b2fa67d56f6ff88e86be08cc5ef0"}, + {file = "snowballstemmer-2.0.0.tar.gz", hash = "sha256:df3bac3df4c2c01363f3dd2cfa78cce2840a79b9f1c2d2de9ce8d31683992f52"}, +] +sphinx = [ + {file = "Sphinx-3.1.1-py3-none-any.whl", hash = "sha256:97c9e3bcce2f61d9f5edf131299ee9d1219630598d9f9a8791459a4d9e815be5"}, + {file = "Sphinx-3.1.1.tar.gz", hash = "sha256:74fbead182a611ce1444f50218a1c5fc70b6cc547f64948f5182fb30a2a20258"}, +] +sphinxcontrib-applehelp = [ + {file = "sphinxcontrib-applehelp-1.0.2.tar.gz", hash = "sha256:a072735ec80e7675e3f432fcae8610ecf509c5f1869d17e2eecff44389cdbc58"}, + {file = "sphinxcontrib_applehelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:806111e5e962be97c29ec4c1e7fe277bfd19e9652fb1a4392105b43e01af885a"}, +] +sphinxcontrib-devhelp = [ + {file = "sphinxcontrib-devhelp-1.0.2.tar.gz", hash = "sha256:ff7f1afa7b9642e7060379360a67e9c41e8f3121f2ce9164266f61b9f4b338e4"}, + {file = "sphinxcontrib_devhelp-1.0.2-py2.py3-none-any.whl", hash = "sha256:8165223f9a335cc1af7ffe1ed31d2871f325254c0423bc0c4c7cd1c1e4734a2e"}, +] +sphinxcontrib-htmlhelp = [ + {file = "sphinxcontrib-htmlhelp-1.0.3.tar.gz", hash = "sha256:e8f5bb7e31b2dbb25b9cc435c8ab7a79787ebf7f906155729338f3156d93659b"}, + {file = "sphinxcontrib_htmlhelp-1.0.3-py2.py3-none-any.whl", hash = "sha256:3c0bc24a2c41e340ac37c85ced6dafc879ab485c095b1d65d2461ac2f7cca86f"}, +] +sphinxcontrib-jsmath = [ + {file = "sphinxcontrib-jsmath-1.0.1.tar.gz", hash = "sha256:a9925e4a4587247ed2191a22df5f6970656cb8ca2bd6284309578f2153e0c4b8"}, + {file = "sphinxcontrib_jsmath-1.0.1-py2.py3-none-any.whl", hash = "sha256:2ec2eaebfb78f3f2078e73666b1415417a116cc848b72e5172e596c871103178"}, +] +sphinxcontrib-qthelp = [ + {file = "sphinxcontrib-qthelp-1.0.3.tar.gz", hash = "sha256:4c33767ee058b70dba89a6fc5c1892c0d57a54be67ddd3e7875a18d14cba5a72"}, + {file = "sphinxcontrib_qthelp-1.0.3-py2.py3-none-any.whl", hash = "sha256:bd9fc24bcb748a8d51fd4ecaade681350aa63009a347a8c14e637895444dfab6"}, +] +sphinxcontrib-serializinghtml = [ + {file = "sphinxcontrib-serializinghtml-1.1.4.tar.gz", hash = "sha256:eaa0eccc86e982a9b939b2b82d12cc5d013385ba5eadcc7e4fed23f4405f77bc"}, + {file = "sphinxcontrib_serializinghtml-1.1.4-py2.py3-none-any.whl", hash = "sha256:f242a81d423f59617a8e5cf16f5d4d74e28ee9a66f9e5b637a18082991db5a9a"}, +] tzlocal = [ {file = "tzlocal-2.1-py2.py3-none-any.whl", hash = "sha256:e2cb6c6b5b604af38597403e9852872d7f534962ae2954c7f35efcb1ccacf4a4"}, {file = "tzlocal-2.1.tar.gz", hash = "sha256:643c97c5294aedc737780a49d9df30889321cbe1204eac2c2ec6134035a92e44"}, ] +urllib3 = [ + {file = "urllib3-1.25.9-py2.py3-none-any.whl", hash = "sha256:88206b0eb87e6d677d424843ac5209e3fb9d0190d0ee169599165ec25e9d9115"}, + {file = "urllib3-1.25.9.tar.gz", hash = "sha256:3018294ebefce6572a474f0604c2021e33b3fd8006ecd11d62107a5d2a963527"}, +] yapf = [ {file = "yapf-0.30.0-py2.py3-none-any.whl", hash = "sha256:3abf61ba67cf603069710d30acbc88cfe565d907e16ad81429ae90ce9651e0c9"}, {file = "yapf-0.30.0.tar.gz", hash = "sha256:3000abee4c28daebad55da6c85f3cd07b8062ce48e2e9943c8da1b9667d48427"}, diff --git a/pyproject.toml b/pyproject.toml index 8c4c3736..bc4928c3 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -28,6 +28,7 @@ apscheduler = { version = "^3.6.3", optional = true } [tool.poetry.dev-dependencies] yapf = "^0.30.0" +sphinx = "^3.1.1" [tool.poetry.extras] scheduler = ["apscheduler"]