mirror of
https://ghfast.top/https://github.com/aeroxw/easy_tdx_max.git
synced 2026-09-12 15:44:18 +08:00
- 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
34 lines
926 B
Python
34 lines
926 B
Python
# -- 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",
|
|
}
|