mirror of
https://ghfast.top/https://github.com/aeroxw/easy-tdx.git
synced 2026-09-12 15:44:15 +08:00
docs: add Sphinx + Read the Docs infrastructure
- Add .readthedocs.yaml build config (Ubuntu 22.04, Python 3.11) - Add docs/conf.py with myst-parser for Markdown support - Add docs/index.md toctree including README and existing docs - Add docs/readme.md to include root README via myst directive - Add docs/requirements.txt for Sphinx build dependencies - Add docs/_build/ to .gitignore
This commit is contained in:
@@ -0,0 +1,33 @@
|
||||
# -- Sphinx configuration for easy-tdx ---------------------------------------
|
||||
project = "easy-tdx"
|
||||
copyright = "2025, Justin Gu"
|
||||
author = "Justin Gu"
|
||||
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = "1.7.1"
|
||||
|
||||
# -- Extensions ---------------------------------------------------------------
|
||||
extensions = [
|
||||
"myst_parser",
|
||||
]
|
||||
|
||||
# -- MyST parser config -------------------------------------------------------
|
||||
myst_enable_extensions = [
|
||||
"colon_fence",
|
||||
"deflist",
|
||||
]
|
||||
|
||||
# Suppress cross-reference warnings for relative links (e.g. docs/*.md, LICENSE)
|
||||
suppress_warnings = ["myst.xref_missing"]
|
||||
|
||||
# -- HTML output --------------------------------------------------------------
|
||||
html_theme = "sphinx_rtd_theme"
|
||||
html_theme_options = {
|
||||
"navigation_depth": 3,
|
||||
}
|
||||
|
||||
# -- Source suffix -------------------------------------------------------------
|
||||
source_suffix = {
|
||||
".rst": "restructuredtext",
|
||||
".md": "markdown",
|
||||
}
|
||||
@@ -0,0 +1,12 @@
|
||||
# easy-tdx 文档
|
||||
|
||||
```{toctree}
|
||||
:maxdepth: 2
|
||||
:caption: 目录
|
||||
|
||||
readme
|
||||
api_reference
|
||||
field_mapping
|
||||
indicator-zhuoyao
|
||||
indicator-bias-signal
|
||||
```
|
||||
@@ -0,0 +1,5 @@
|
||||
# easy-tdx
|
||||
|
||||
```{include} ../README.md
|
||||
:relative-images:
|
||||
```
|
||||
@@ -0,0 +1,4 @@
|
||||
sphinx>=7.0
|
||||
sphinx-autobuild>=2024.0
|
||||
myst-parser>=3.0
|
||||
sphinx-rtd-theme>=2.0
|
||||
Reference in New Issue
Block a user