Add docs

docs/source/conf.py

@@ -0,0 +1,56 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = "WeChatFerry"
+copyright = "2023, Changhua"
+author = "Changhua"
+release = "3.7.0.30"
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+templates_path = ["_templates"]
+exclude_patterns = []
+
+language = "zh_CN"
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+source_suffix = {
+    ".rst": "restructuredtext",
+    ".md": "markdown",
+}
+master_doc = "index"
+
+# -- General configuration
+extensions = [
+    "myst_parser",
+    "autoapi.extension",
+    "sphinx.ext.intersphinx",
+    "sphinx_copybutton",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3/", None),
+    "sphinx": ("https://www.sphinx-doc.org/en/master/", None),
+}
+intersphinx_disabled_domains = ["std"]
+
+
+myst_heading_anchors = 3
+myst_ref_domains = ["std", "py"]
+myst_enable_extensions = ["linkify", "colon_fence"]
+
+# Document Python Code
+autoapi_type = "python"
+autoapi_dirs = ["../../python/wcferry"]
+autoapi_member_order = "groupwise"
+autoapi_options = ["members", "undoc-members", "show-inheritance", "show-module-summary", "imported-members"]

docs/source/index.rst

@@ -0,0 +1,21 @@
+.. PackageName documentation master file, created by
+   sphinx-quickstart on Tue Jan 31 12:31:42 2017.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+WeChatFerry
+=======================================
+
+.. toctree::
+   :maxdepth: 4
+
+   readme_link
+   autoapi/index
+
+
+索引及附录
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`

docs/source/readme_link.rst

@@ -0,0 +1,5 @@
+README
+=======
+
+.. include:: ../../python/README.MD
+   :parser: myst_parser.sphinx_