Merge pull request #19 from zsrl/develop

perf: 文档站初始化
zsrl · Dec 17, 2024 · 2d38957 · 2d38957
2 parents b123681 + b07df14
commit 2d38957
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 0 deletions.
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,13 @@
+version: 2
+
+build:
+  os: ubuntu-24.04
+  tools:
+    python: "3"
+
+python:
+  install:
+    - requirements: docs/requirements.txt
+
+mkdocs:
+  configuration: mkdocs.yml
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+# 测试一下
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -0,0 +1 @@
+mkdocs-material
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -0,0 +1,10 @@
+# Define the site name
+site_name: tdxtrader文档
+
+# Set the site URL by using a Read the Docs environment variable:
+# https://docs.readthedocs.io/en/stable/reference/environment-variables.html
+site_url: !ENV READTHEDOCS_CANONICAL_URL
+
+# Set the Material for MkDocs theme
+theme:
+  name: material