diff options
| -rw-r--r-- | docs/source/CONTRIBUTING.md | 2 | ||||
| -rw-r--r-- | docs/source/about/index.rst | 2 | ||||
| -rw-r--r-- | docs/source/changelog.md | 2 | ||||
| -rw-r--r-- | docs/source/index.md | 46 | ||||
| -rw-r--r-- | docs/source/index.rst | 27 | ||||
| -rw-r--r-- | docs/source/license.md | 24 | ||||
| -rw-r--r-- | docs/source/v1/best_practice.rst | 2 | ||||
| -rw-r--r-- | docs/source/v1/glossary.rst | 4 | ||||
| -rw-r--r-- | docs/source/v1/implementation.rst | 2 | ||||
| -rw-r--r-- | docs/source/v1/index.rst | 9 | ||||
| -rw-r--r-- | docs/source/v1/specification.rst | 2 |
11 files changed, 54 insertions, 68 deletions
diff --git a/docs/source/CONTRIBUTING.md b/docs/source/CONTRIBUTING.md deleted file mode 100644 index e75758c..0000000 --- a/docs/source/CONTRIBUTING.md +++ /dev/null @@ -1,2 +0,0 @@ -```{include} ../../CONTRIBUTING.md -```
\ No newline at end of file diff --git a/docs/source/about/index.rst b/docs/source/about/index.rst new file mode 100644 index 0000000..d4d0bfe --- /dev/null +++ b/docs/source/about/index.rst @@ -0,0 +1,2 @@ +关于 +====
\ No newline at end of file diff --git a/docs/source/changelog.md b/docs/source/changelog.md index 769b66e..e60988d 100644 --- a/docs/source/changelog.md +++ b/docs/source/changelog.md @@ -9,5 +9,7 @@ https://en.wikipedia.org/wiki/Lists_of_colors --> +# 文档变更日志 + ```{include} ../../CHANGELOG.md ```
\ No newline at end of file diff --git a/docs/source/index.md b/docs/source/index.md deleted file mode 100644 index 5c32c61..0000000 --- a/docs/source/index.md +++ /dev/null @@ -1,46 +0,0 @@ ---- -hide-toc: true ---- - -# GRPS - -```{include} ../../README.md -:start-after: <!-- start index --> -:end-before: <!-- end index --> -``` - -```{toctree} -:hidden: - -简述 <index> -``` - -```{toctree} -:hidden: - -快速开始 <quick-start> -核心模块: core <pages/core> -生成器: generator <pages/generator> -处理器: handler <pages/handler> -注入模块: injector <pages/injector> -拦截器: interceptor <pages/interceptor> -包引用: internal <pages/internal> -注册器: register <pages/register> -工作流: workflow <pages/workflow> -``` - -```{toctree} -:caption: API 接口 -:hidden: - -阅读源码 <pages/api/index> -``` - -```{toctree} -:caption: 开发手册 -:hidden: - -社区贡献指引 <CONTRIBUTING> -变更日志 <changelog> -协议 <license> -``` diff --git a/docs/source/index.rst b/docs/source/index.rst new file mode 100644 index 0000000..22f1612 --- /dev/null +++ b/docs/source/index.rst @@ -0,0 +1,27 @@ +.. hide-toc: true + +GRPS 通用规则包标准 +===================== + +.. include:: ../../README.rst + .. :start-after: start-index + .. :end-before: end-index + + +.. toctree:: + :hidden: + + about/index + +.. toctree:: + :hidden: + :caption: Development + + v1/index + +.. toctree:: + :hidden: + :caption: Community + + license + changelog diff --git a/docs/source/license.md b/docs/source/license.md index 3c74706..4b5d790 100644 --- a/docs/source/license.md +++ b/docs/source/license.md @@ -1,21 +1,5 @@ -MIT License +# 协议 -Copyright (c) 2023 HydroRoll-Team & Noctisynth, org - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +```{include} ../../LICENSE +:tocdepth: 2 +```
\ No newline at end of file diff --git a/docs/source/v1/best_practice.rst b/docs/source/v1/best_practice.rst new file mode 100644 index 0000000..4e93058 --- /dev/null +++ b/docs/source/v1/best_practice.rst @@ -0,0 +1,2 @@ +最佳实践 +========
\ No newline at end of file diff --git a/docs/source/v1/glossary.rst b/docs/source/v1/glossary.rst new file mode 100644 index 0000000..a9f9373 --- /dev/null +++ b/docs/source/v1/glossary.rst @@ -0,0 +1,4 @@ +术语表 +====== + +本章节包含 GRPSv1 通用规则包标准 (GRPS) 相关的术语和定义。
\ No newline at end of file diff --git a/docs/source/v1/implementation.rst b/docs/source/v1/implementation.rst new file mode 100644 index 0000000..70e3756 --- /dev/null +++ b/docs/source/v1/implementation.rst @@ -0,0 +1,2 @@ +实现 +====
\ No newline at end of file diff --git a/docs/source/v1/index.rst b/docs/source/v1/index.rst new file mode 100644 index 0000000..96fc410 --- /dev/null +++ b/docs/source/v1/index.rst @@ -0,0 +1,9 @@ +GRPSv1 +====== + +.. toctree:: + + specification + implementation + best_practice + glossary
\ No newline at end of file diff --git a/docs/source/v1/specification.rst b/docs/source/v1/specification.rst new file mode 100644 index 0000000..fa7d43c --- /dev/null +++ b/docs/source/v1/specification.rst @@ -0,0 +1,2 @@ +规范 +====
\ No newline at end of file |