docs!: rewrite side bar structures

HydroRoll-Team · Jul 6, 2024 · da32df8 · da32df8
1 parent 7e655c9
commit da32df8
Show file tree

Hide file tree

Showing 8 changed files with 685 additions and 15 deletions.
diff --git a/docs/Makefile b/docs/Makefile
@@ -9,6 +9,7 @@ SOURCEDIR     = source
 BUILDDIR      = _build
 SPHINXINTL    ?= sphinx-intl 
 lang		  ?= zh_CN
+SPHINX 		  ?= sphinx
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -23,4 +24,8 @@ help:
 
 # update translation command
 translate:
-	@$(SPHINXINTL) update -p ./build/gettext -l $(lang) $(O)
+	@$(SPHINXINTL) update -p ./build/gettext -l $(lang) $(O)
+
+# build docs
+docs build:
+	@pdm run $(SPHINXBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(O)
diff --git a/docs/source/COPYING.md b/docs/source/COPYING.md
diff --git a/docs/source/COPYING.rst b/docs/source/COPYING.rst
diff --git a/docs/source/changelog.md b/docs/source/changelog.md
@@ -0,0 +1,4 @@
+<!-- max_depth: 1 -->
+
+```{include} ../../CHANGELOG.md 
+```
diff --git a/docs/source/changelog.rst b/docs/source/changelog.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -11,13 +11,15 @@ HydroRollCore
 .. toctree::
     :hidden:
 
+
     快速开始 <pages/quick-start.rst>
 
 
 .. toctree::
-    :caption: Development
-    :hidden:
+   :caption: Development
+   :hidden:
+
 
     贡献指南 <pages/contributing.rst>
-    变更日志 <changelog.rst>
-    COPYING <COPYING.rst>
+    变更日志 <changelog>
+    COPYING <COPYING>
diff --git a/pdm.lock b/pdm.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -95,7 +95,7 @@ module-name = "hrc.LibCore"
 docs = [
     "furo>=2024.1.29",
     "sphinx-autobuild>=2024.4.16",
-    "myst-parser>=2.0.0",
+    "myst-parser>=3.0.1",
     "sphinx>=7.3.7",
     "tomli>=2.0.1",
     "sphinx-design>=0.5.0",