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

.gitignore

@@ -12,3 +12,4 @@ build/
 venv/
 .omc/
 uv.lock
+docs/_build/

.readthedocs.yaml

@@ -0,0 +1,18 @@
+# .readthedocs.yaml
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+
+formats:
+  - pdf
+  - epub
+
+python:
+  install:
+    - requirements: docs/requirements.txt

README.md

@@ -1,11 +1,7 @@
 # easy-tdx
 
-# easy-tdx
-
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
 [![PyPI](https://img.shields.io/pypi/v/easy-tdx.svg)](https://pypi.org/project/easy-tdx/)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/easy-tdx)](https://pypi.org/project/easy-tdx/)
-[![Python Version](https://img.shields.io/pypi/pyversions/easy-tdx)](https://pypi.org/project/easy-tdx/)
 [![GitHub Repo stars](https://img.shields.io/github/stars/handsomejustin/easy-tdx?style=social)](https://github.com/handsomejustin/easy-tdx)
 [![GitHub last commit](https://img.shields.io/github/last-commit/handsomejustin/easy-tdx)](https://github.com/handsomejustin/easy-tdx)
 [![Read the Docs](https://img.shields.io/readthedocs/easy-tdx)](https://easy-tdx.readthedocs.io/)

docs/conf.py

@@ -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",
+}

docs/index.md

@@ -0,0 +1,12 @@
+# easy-tdx 文档
+
+```{toctree}
+:maxdepth: 2
+:caption: 目录
+
+readme
+api_reference
+field_mapping
+indicator-zhuoyao
+indicator-bias-signal
+```

docs/readme.md

@@ -0,0 +1,5 @@
+# easy-tdx
+
+```{include} ../README.md
+:relative-images:
+```

docs/requirements.txt

@@ -0,0 +1,4 @@
+sphinx>=7.0
+sphinx-autobuild>=2024.0
+myst-parser>=3.0
+sphinx-rtd-theme>=2.0