diff options
Diffstat (limited to 'docs/source')
| -rw-r--r-- | docs/source/about/index.rst | 4 | ||||
| -rw-r--r-- | docs/source/conf.py | 8 | ||||
| -rw-r--r-- | docs/source/index.rst | 13 |
3 files changed, 18 insertions, 7 deletions
diff --git a/docs/source/about/index.rst b/docs/source/about/index.rst new file mode 100644 index 0000000..4d4541f --- /dev/null +++ b/docs/source/about/index.rst @@ -0,0 +1,4 @@ +定义 +==== + +HydroRoll diff --git a/docs/source/conf.py b/docs/source/conf.py index e93290f..8b8fb69 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -82,15 +82,15 @@ rst_epilog = """ .. |hr| replace:: HydroRoll .. |hrc| replace:: HydroRollCore """ -locale_dirs = ["../locales/"] # path is example but recommended. +# locale_dirs = ["../locales/"] # path is example but recommended. gettext_compact = False # optional. gettext_uuid = True # optional. numfig = True # Figures, tables and code blocks are automatically numbered if they have a title pygments_style = "rrt" # default sphinx, change the style of code block math_number_all = True # Number all equations, figures, tables and code blocks -html_additional_pages = { - "copy": "copying.html", -} +# html_additional_pages = { +# "copy": "copying.html", +# } html_split_index = True # Split the index page by each alphabet # -- Options for HTML output ------------------------------------------------- # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output diff --git a/docs/source/index.rst b/docs/source/index.rst index 49bf7ce..4c42dc3 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,4 +1,11 @@ -Docs Template -============= +HydroWiki +========= -This is a template for documentation projects.
\ No newline at end of file +欢迎访问 HydroWiki —— 由社区驱动的 HydroRoll Native 知识库！ + +在开始之前非常推荐查看 术语表。 + +.. toctree:: + :caption: 关于 HydroRoll + + about/index |