aboutsummaryrefslogtreecommitdiffstatshomepage
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/Makefile31
-rw-r--r--docs/_static/.gitkeep0
-rw-r--r--docs/requirements.txt7
-rw-r--r--docs/source/index.rst4
4 files changed, 42 insertions, 0 deletions
diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..08a2dd0
--- /dev/null
+++ b/docs/Makefile
@@ -0,0 +1,31 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS ?=
+SPHINXBUILD ?= sphinx-build
+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:
+ @$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+ @pdm run $(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+# update translation command
+translate:
+ @pdm run $(SPHINXINTL) update -p ./build/gettext -l $(lang) $(O)
+
+# build docs
+docs build:
+ @pdm run $(SPHINXBUILD) "$(SOURCEDIR)" "$(BUILDDIR)" $(O) \ No newline at end of file
diff --git a/docs/_static/.gitkeep b/docs/_static/.gitkeep
new file mode 100644
index 0000000..e69de29
--- /dev/null
+++ b/docs/_static/.gitkeep
diff --git a/docs/requirements.txt b/docs/requirements.txt
new file mode 100644
index 0000000..6b39a20
--- /dev/null
+++ b/docs/requirements.txt
@@ -0,0 +1,7 @@
+furo>=2024.7.18
+sphinx-autobuild>=2024.4.16
+myst-parser>=3.0.1
+sphinx>=7.4.7
+tomli>=2.0.1
+sphinx_design>=0.6.0
+sphinx-intl>=2.2.0 \ No newline at end of file
diff --git a/docs/source/index.rst b/docs/source/index.rst
new file mode 100644
index 0000000..49bf7ce
--- /dev/null
+++ b/docs/source/index.rst
@@ -0,0 +1,4 @@
+Docs Template
+=============
+
+This is a template for documentation projects. \ No newline at end of file