From 12b7bcb40ae38f676c81c5559562e52b6b64c66f Mon Sep 17 00:00:00 2001 From: 简律纯 Date: Thu, 15 Aug 2024 17:23:34 +0800 Subject: Initial commit --- docs/Makefile | 31 +++++++++++++++++++++++++++++++ docs/_static/.gitkeep | 0 docs/requirements.txt | 7 +++++++ docs/source/index.rst | 4 ++++ 4 files changed, 42 insertions(+) create mode 100644 docs/Makefile create mode 100644 docs/_static/.gitkeep create mode 100644 docs/requirements.txt create mode 100644 docs/source/index.rst (limited to 'docs') 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 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 -- cgit v1.2.3-70-g09d2