From 67a4e90568903200102ca369e3522d9093877277 Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Wed, 28 Feb 2024 11:02:45 +0800 Subject: feat(docs): enable docs preview --- docs/source/changelog.md | 13 ++++ docs/source/conf.py | 97 ++++++++++++++++++++++++++++ docs/source/index.rst | 40 ++++++++++++ docs/source/pages/api/index.rst | 7 ++ docs/source/pages/api/infini.core.rst | 7 ++ docs/source/pages/api/infini.exceptions.rst | 7 ++ docs/source/pages/api/infini.generator.rst | 7 ++ docs/source/pages/api/infini.handler.rst | 7 ++ docs/source/pages/api/infini.input.rst | 7 ++ docs/source/pages/api/infini.interceptor.rst | 7 ++ docs/source/pages/api/infini.internal.rst | 7 ++ docs/source/pages/api/infini.loader.rst | 7 ++ docs/source/pages/api/infini.logging.rst | 7 ++ docs/source/pages/api/infini.output.rst | 7 ++ docs/source/pages/api/infini.queue.rst | 7 ++ docs/source/pages/api/infini.register.rst | 7 ++ docs/source/pages/api/infini.router.rst | 7 ++ docs/source/pages/api/infini.rst | 31 +++++++++ docs/source/pages/api/infini.typing.rst | 7 ++ docs/source/pages/grps-1/index.md | 1 + 20 files changed, 287 insertions(+) create mode 100644 docs/source/changelog.md create mode 100644 docs/source/conf.py create mode 100644 docs/source/index.rst create mode 100644 docs/source/pages/api/index.rst create mode 100644 docs/source/pages/api/infini.core.rst create mode 100644 docs/source/pages/api/infini.exceptions.rst create mode 100644 docs/source/pages/api/infini.generator.rst create mode 100644 docs/source/pages/api/infini.handler.rst create mode 100644 docs/source/pages/api/infini.input.rst create mode 100644 docs/source/pages/api/infini.interceptor.rst create mode 100644 docs/source/pages/api/infini.internal.rst create mode 100644 docs/source/pages/api/infini.loader.rst create mode 100644 docs/source/pages/api/infini.logging.rst create mode 100644 docs/source/pages/api/infini.output.rst create mode 100644 docs/source/pages/api/infini.queue.rst create mode 100644 docs/source/pages/api/infini.register.rst create mode 100644 docs/source/pages/api/infini.router.rst create mode 100644 docs/source/pages/api/infini.rst create mode 100644 docs/source/pages/api/infini.typing.rst create mode 100644 docs/source/pages/grps-1/index.md (limited to 'docs/source') diff --git a/docs/source/changelog.md b/docs/source/changelog.md new file mode 100644 index 0000000..769b66e --- /dev/null +++ b/docs/source/changelog.md @@ -0,0 +1,13 @@ + + +```{include} ../../CHANGELOG.md +``` \ No newline at end of file diff --git a/docs/source/conf.py b/docs/source/conf.py new file mode 100644 index 0000000..2284814 --- /dev/null +++ b/docs/source/conf.py @@ -0,0 +1,97 @@ +# 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 + +import infini +import os, sys + +if sys.version_info >= (3, 11): + import tomllib +else: + import tomli as tomllib + +DATA = None +PYPROJECT = os.path.join("..", "..", "Cargo.toml") +with open(PYPROJECT, "r", encoding="utf8") as f: + pyproject = f.read() + DATA = tomllib.loads(pyproject) +PROJECT_VERSION = DATA["package"]["version"] +PROJECT_NAME = DATA["package"]["name"] +AUTHOR_TABLE = DATA["package"]["authors"] +AUTHORS = ",".join([f"{aut}" for aut in AUTHOR_TABLE]) + +# -- Project information ----------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information + +project = "HydroRoll" # PROJECT_NAME +release = PROJECT_VERSION # "latest" +copyright = "2023-PRESENT, HydroRoll-Team." +author = AUTHORS # "Hsiang Nianian" + +# html_title = "HydroRoll Docs" + +# -- General configuration --------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration + +extensions = [ + "sphinx.ext.autodoc", + "sphinx.ext.viewcode", + "sphinx.ext.todo", + "sphinx.ext.napoleon", + "sphinx.ext.autosummary", + "sphinx.ext.extlinks", + "myst_parser", +] + +templates_path = ["_templates"] +exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"] +extlinks = { + "issue": ("https://github.com/HydroRoll-Team/HydroRoll/%s", "issue %s"), + "doc": ("https://docs.hydroroll.team/zh_CN/latest/%s", "pages/%s"), +} +source_suffix = { + ".rst": "restructuredtext", + ".txt": "markdown", + ".md": "markdown", +} + +locale_dirs = ["../locales/"] # path is example but recommended. +gettext_compact = False # optional. +gettext_uuid = True # optional. + +# -- Options for HTML output ------------------------------------------------- +# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output + +html_theme = "furo" +html_static_path = ["../_static"] +_html_logo = ( + "https://cdn.jsdelivr.net/gh/HydroRoll-Team/HydroRoll@main/docs/_static/logo.png" +) +html_favicon = _html_logo + +html_css_files = [ + "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/fontawesome.min.css", + "https://cdnjs.cloudflare.com/ajax/libs/font-awesome/6.0.0/css/brands.min.css", +] + +html_theme_options = { + "announcement": "documentation is still under construction now, welcome any contribution!", + "source_repository": "https://github.com/HydroRoll-Team/HydroRoll/", + "source_branch": "main", + "source_directory": "docs/source/", + "footer_icons": [ + { + "name": "GitHub", + "url": "https://github.com/HydroRoll-Team/HydroRoll/", + "html": "", + "class": "fa-brands fa-github", + }, + { + "name": "Pypi", + "url": "https://pypi.org/project/hydro_roll/", + "html": "", + "class": "fa-brands fa-python", + }, + ], +} diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..b6bd37e --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,40 @@ +--- +hide-toc: true +--- + +.. include:: ../../README.rst + :start-after: start-index + :end-before: end-index + + +.. .. toctree:: +.. :hidden: +.. :caption: 用户手册 + +.. 第一步 +.. 使用脚手架 +.. 更多的配置 +.. webui 基础 +.. NIVIS 基本语法 +.. OneRoll 语法概览 +.. webui 进阶 +.. 最佳实践 + +.. .. toctree:: +.. :hidden: +.. :caption: 开发手册 + +.. 成为脚本插件作者 +.. 成为规则包作者 +.. 成为模型作者 + +.. API 文档 +.. 开发建议 + +.. .. toctree:: +.. :hidden: +.. :caption: Thanks and Credits + +.. 社区贡献指南 +.. 变更日志 +.. 协议 \ No newline at end of file diff --git a/docs/source/pages/api/index.rst b/docs/source/pages/api/index.rst new file mode 100644 index 0000000..704f2ae --- /dev/null +++ b/docs/source/pages/api/index.rst @@ -0,0 +1,7 @@ +infini +====== + +.. toctree:: + :maxdepth: 4 + + infini diff --git a/docs/source/pages/api/infini.core.rst b/docs/source/pages/api/infini.core.rst new file mode 100644 index 0000000..084db94 --- /dev/null +++ b/docs/source/pages/api/infini.core.rst @@ -0,0 +1,7 @@ +infini.core module +================== + +.. automodule:: infini.core + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.exceptions.rst b/docs/source/pages/api/infini.exceptions.rst new file mode 100644 index 0000000..bdc8ef6 --- /dev/null +++ b/docs/source/pages/api/infini.exceptions.rst @@ -0,0 +1,7 @@ +infini.exceptions module +======================== + +.. automodule:: infini.exceptions + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.generator.rst b/docs/source/pages/api/infini.generator.rst new file mode 100644 index 0000000..c5055ff --- /dev/null +++ b/docs/source/pages/api/infini.generator.rst @@ -0,0 +1,7 @@ +infini.generator module +======================= + +.. automodule:: infini.generator + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.handler.rst b/docs/source/pages/api/infini.handler.rst new file mode 100644 index 0000000..5b7742c --- /dev/null +++ b/docs/source/pages/api/infini.handler.rst @@ -0,0 +1,7 @@ +infini.handler module +===================== + +.. automodule:: infini.handler + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.input.rst b/docs/source/pages/api/infini.input.rst new file mode 100644 index 0000000..184a0b0 --- /dev/null +++ b/docs/source/pages/api/infini.input.rst @@ -0,0 +1,7 @@ +infini.input module +=================== + +.. automodule:: infini.input + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.interceptor.rst b/docs/source/pages/api/infini.interceptor.rst new file mode 100644 index 0000000..fa99039 --- /dev/null +++ b/docs/source/pages/api/infini.interceptor.rst @@ -0,0 +1,7 @@ +infini.interceptor module +========================= + +.. automodule:: infini.interceptor + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.internal.rst b/docs/source/pages/api/infini.internal.rst new file mode 100644 index 0000000..e0abeb4 --- /dev/null +++ b/docs/source/pages/api/infini.internal.rst @@ -0,0 +1,7 @@ +infini.internal module +====================== + +.. automodule:: infini.internal + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.loader.rst b/docs/source/pages/api/infini.loader.rst new file mode 100644 index 0000000..29d5832 --- /dev/null +++ b/docs/source/pages/api/infini.loader.rst @@ -0,0 +1,7 @@ +infini.loader module +==================== + +.. automodule:: infini.loader + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.logging.rst b/docs/source/pages/api/infini.logging.rst new file mode 100644 index 0000000..8aa7635 --- /dev/null +++ b/docs/source/pages/api/infini.logging.rst @@ -0,0 +1,7 @@ +infini.logging module +===================== + +.. automodule:: infini.logging + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.output.rst b/docs/source/pages/api/infini.output.rst new file mode 100644 index 0000000..33ec78f --- /dev/null +++ b/docs/source/pages/api/infini.output.rst @@ -0,0 +1,7 @@ +infini.output module +==================== + +.. automodule:: infini.output + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.queue.rst b/docs/source/pages/api/infini.queue.rst new file mode 100644 index 0000000..19401f4 --- /dev/null +++ b/docs/source/pages/api/infini.queue.rst @@ -0,0 +1,7 @@ +infini.queue module +=================== + +.. automodule:: infini.queue + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.register.rst b/docs/source/pages/api/infini.register.rst new file mode 100644 index 0000000..8719967 --- /dev/null +++ b/docs/source/pages/api/infini.register.rst @@ -0,0 +1,7 @@ +infini.register module +====================== + +.. automodule:: infini.register + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.router.rst b/docs/source/pages/api/infini.router.rst new file mode 100644 index 0000000..512aa45 --- /dev/null +++ b/docs/source/pages/api/infini.router.rst @@ -0,0 +1,7 @@ +infini.router module +==================== + +.. automodule:: infini.router + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.rst b/docs/source/pages/api/infini.rst new file mode 100644 index 0000000..dbc0cd2 --- /dev/null +++ b/docs/source/pages/api/infini.rst @@ -0,0 +1,31 @@ +infini package +============== + +Submodules +---------- + +.. toctree:: + :maxdepth: 4 + + infini.core + infini.exceptions + infini.generator + infini.handler + infini.input + infini.interceptor + infini.internal + infini.loader + infini.logging + infini.output + infini.queue + infini.register + infini.router + infini.typing + +Module contents +--------------- + +.. automodule:: infini + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/api/infini.typing.rst b/docs/source/pages/api/infini.typing.rst new file mode 100644 index 0000000..cb13429 --- /dev/null +++ b/docs/source/pages/api/infini.typing.rst @@ -0,0 +1,7 @@ +infini.typing module +==================== + +.. automodule:: infini.typing + :members: + :undoc-members: + :show-inheritance: diff --git a/docs/source/pages/grps-1/index.md b/docs/source/pages/grps-1/index.md new file mode 100644 index 0000000..d56fffd --- /dev/null +++ b/docs/source/pages/grps-1/index.md @@ -0,0 +1 @@ +# 通用规则包标准 \ No newline at end of file -- cgit v1.2.3-70-g09d2