扩展指标

2026-07-09 05:08:16 +08:00
commit 308c46ab9a
537 changed files with 152299 additions and 0 deletions
@@ -0,0 +1,98 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+import os
+import re
+import sys
+from pathlib import Path
+
+try:
+    import tomllib
+except ImportError:  # pragma: no cover
+    try:
+        import tomli as tomllib  # type: ignore[no-redef]
+    except ImportError:  # pragma: no cover
+        tomllib = None  # type: ignore[assignment]
+
+# Add the python source directory so autodoc can import ferro_ta
+# Only add if ferro_ta is not already installed (e.g. from a wheel in CI)
+try:
+    import ferro_ta  # noqa: F401
+except ImportError:
+    sys.path.insert(0, os.path.abspath("../python"))
+
+# -- Project information -------------------------------------------------------
+project = "ferro-ta"
+copyright = "2024, pratikbhadane24"
+author = "pratikbhadane24"
+
+
+def _default_release() -> str:
+    if tomllib is None:
+        return "0+unknown"
+    pyproject_toml = Path(__file__).resolve().parents[1] / "pyproject.toml"
+    try:
+        if tomllib is not None:
+            with pyproject_toml.open("rb") as handle:
+                data = tomllib.load(handle)
+            return data.get("project", {}).get("version", "0+unknown")
+        text = pyproject_toml.read_text(encoding="utf-8")
+        match = re.search(r'^version\s*=\s*"([^"]+)"', text, re.MULTILINE)
+        if match:
+            return match.group(1)
+        return "0+unknown"
+    except Exception:
+        return "0+unknown"
+
+
+# Version from env (e.g. set in CI from git tag) or default to pyproject.toml
+release = os.environ.get("FERRO_TA_VERSION", _default_release())
+version = release
+
+# -- General configuration ----------------------------------------------------
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",  # Google / NumPy-style docstrings
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+]
+
+intersphinx_mapping = {
+    "python": ("https://docs.python.org/3", None),
+    "numpy": ("https://numpy.org/doc/stable", None),
+    "pandas": ("https://pandas.pydata.org/docs", None),
+}
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+# -- Options for HTML output --------------------------------------------------
+html_theme = "sphinx_rtd_theme"
+html_static_path = ["_static"]
+html_title = "ferro-ta Documentation"
+html_short_title = "ferro-ta"
+
+# -- autodoc ------------------------------------------------------------------
+autodoc_default_options = {
+    "members": True,
+    "undoc-members": True,
+    "show-inheritance": True,
+}
+autodoc_typehints = "description"
+napoleon_google_docstring = False
+napoleon_numpy_docstring = True
+
+# Suppress autodoc import warnings for modules that can't be loaded without
+# the compiled Rust extension (_ferro_ta). These are expected when building
+# docs without the wheel; the documented API is still accurate.
+# Also suppress duplicate object descriptions that arise when Rust-backed
+# streaming classes (defined in ferro_ta._ferro_ta) are re-exported through
+# ferro_ta.streaming — autodoc sees them in both modules.
+suppress_warnings = [
+    "autodoc.import_object",
+    "ref.doc",
+    "py.duplicate",
+]