aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs/source
diff options
context:
space:
mode:
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/changelog.md5
-rw-r--r--docs/source/conf.py20
-rw-r--r--docs/source/index.md2
-rw-r--r--docs/source/license.md23
4 files changed, 37 insertions, 13 deletions
diff --git a/docs/source/changelog.md b/docs/source/changelog.md
index efc8cca8..769b66e7 100644
--- a/docs/source/changelog.md
+++ b/docs/source/changelog.md
@@ -1,5 +1,3 @@
-# 变更日志
-
<!--
Version codenames style:
@@ -10,3 +8,6 @@ https://patternbasedwriting.com/elementary_writing_success/list-4800-adjectives/
https://en.wikipedia.org/wiki/Lists_of_colors
-->
+
+```{include} ../../CHANGELOG.md
+``` \ No newline at end of file
diff --git a/docs/source/conf.py b/docs/source/conf.py
index c2403d47..319cfd92 100644
--- a/docs/source/conf.py
+++ b/docs/source/conf.py
@@ -19,17 +19,19 @@ with open(PYPROJECT, "r", encoding="utf8") as f:
PROJECT_VERSION = DATA["project"]["version"]
PROJECT_NAME = DATA["project"]["name"]
AUTHOR_TABLE = DATA["project"]["authors"]
-AUTHORS = ",".join([f"{aut['name']}<{aut['email']}>" for aut in AUTHOR_TABLE])
+AUTHORS = ",".join([f"{aut['name']}" for aut in AUTHOR_TABLE])
# -- Project information -----------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
-project = PROJECT_NAME # "IamAI"
+project = PROJECT_NAME # "Infini"
release = PROJECT_VERSION # "latest"
-copyright = "2023-PRESENT, HydroRoll-Team."
-author = "Hsiang Nianian" # AUTHORS
+copyright = (
+ "2023-PRESENT, HydroRoll-Team & 浊莲."
+)
+author = AUTHORS # "Hsiang Nianian"
-# html_title = "Who am I? I am AI."
+html_title = "INFINI GENERATOR II"
# -- General configuration ---------------------------------------------------
# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
@@ -65,7 +67,9 @@ gettext_uuid = True # optional.
html_theme = "furo"
html_static_path = ["../_static"]
-html_logo = "https://cdn.jsdelivr.net/gh/HydroRoll-Team/infini@master/docs/_static/logo.png"
+html_logo = (
+ "https://cdn.jsdelivr.net/gh/HydroRoll-Team/infini@master/docs/_static/logo.png"
+)
html_favicon = html_logo
html_css_files = [
@@ -74,7 +78,7 @@ html_css_files = [
]
html_theme_options = {
- "announcement": "<em><a href='#'>documentation</a> is still under construction now, welcome any <a href='contributing.html'>contribution</a>!</em>",
+ # "announcement": "<em><a href='#'>documentation</a> is still under construction now, welcome any <a href='contributing.html'>contribution</a>!</em>",
"source_repository": "https://github.com/HydroRoll-Team/infini/",
"source_branch": "master",
"source_directory": "docs/source/",
@@ -92,4 +96,4 @@ html_theme_options = {
"class": "fa-brands fa-python",
},
],
-} \ No newline at end of file
+}
diff --git a/docs/source/index.md b/docs/source/index.md
index cd1a0d36..7e5fe6f1 100644
--- a/docs/source/index.md
+++ b/docs/source/index.md
@@ -26,7 +26,7 @@ pages/grps-1/index
:caption: API 接口
:hidden:
-源码文档 <pages/api/index>
+阅读源码 <pages/api/index>
```
```{toctree}
diff --git a/docs/source/license.md b/docs/source/license.md
index 1d1521fe..ab2c80e0 100644
--- a/docs/source/license.md
+++ b/docs/source/license.md
@@ -1,2 +1,21 @@
-```{include} ../../LICENSE
-``` \ No newline at end of file
+MIT License
+
+Copyright (c) 2023 HydroRoll-Team & 浊莲
+
+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.