cyonjan/WeChatFerry
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update docs

Browse Source
This commit is contained in:
Changhua 2023-05-08 16:13:43 +08:00
parent d3d64ec68f
commit 1c1ffa829f
7 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/requirements.txt
View File

@ -4,4 +4,5 @@ myst_parser
sphinx sphinx
sphinx_copybutton sphinx_copybutton
sphinx_rtd_theme sphinx_rtd_theme
sphinxcontrib-openapi
sphinxcontrib-napoleon sphinxcontrib-napoleon

BIN
docs/source/_static/QRCodes.jpg Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 254 KiB

1
docs/source/_static/openapi-wcfhttp.json Normal file
View File

File diff suppressed because one or more lines are too long

1
docs/source/conf.py
View File

@ -34,6 +34,7 @@ master_doc = "index"
extensions = [ extensions = [
"myst_parser", "myst_parser",
"autoapi.extension", "autoapi.extension",
"sphinxcontrib.openapi",
"sphinx.ext.intersphinx", "sphinx.ext.intersphinx",
"sphinx.ext.napoleon", "sphinx.ext.napoleon",
"sphinx_copybutton", "sphinx_copybutton",

3
docs/source/index.rst
View File

@ -6,10 +6,13 @@
WeChatFerry WeChatFerry
======================================= =======================================
.. image:: _static/QRCodes.jpg
.. toctree:: .. toctree::
:maxdepth: 4 :maxdepth: 4
readme_link readme_link
openapi
autoapi/index autoapi/index

11
docs/source/openapi.rst Normal file
View File

@ -0,0 +1,11 @@
OpenAPI
=========
.. toctree::
:titlesonly:
wcfhttp
-------
从 docs 中查看更详细（默认地址为：http://localhost:9999/docs ）。
.. openapi:: _static/openapi-wcfhttp.json

3
docs/source/readme_link.rst
View File

@ -1,5 +1,8 @@
项目介绍 项目介绍
========= =========
.. include:: ../../http/README.MD
:parser: myst_parser.sphinx_
.. include:: ../../python/README.MD .. include:: ../../python/README.MD
:parser: myst_parser.sphinx_ :parser: myst_parser.sphinx_