This is an automated email from the ASF dual-hosted git repository.
skrawcz pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/hamilton.git
The following commit(s) were added to refs/heads/main by this push:
new d4319d5f Add the sphinx-llms-txt docs plugin for better LLM
integration (#1482)
d4319d5f is described below
commit d4319d5f736e3b59f62fa3c25e61f4b665705dc0
Author: Dev-iL <[email protected]>
AuthorDate: Tue Feb 17 06:43:44 2026 +0200
Add the sphinx-llms-txt docs plugin for better LLM integration (#1482)
* Add the sphinx-llms-txt plugin
* Remove outdated sphinx pins
https://blog.readthedocs.com/defaulting-latest-build-tools/
---
docs/conf.py | 8 ++++++++
pyproject.toml | 17 +++++++++--------
2 files changed, 17 insertions(+), 8 deletions(-)
diff --git a/docs/conf.py b/docs/conf.py
index a9facf23..bac11012 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -73,10 +73,18 @@ extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.autosummary",
"myst_nb",
+ "sphinx_llms_txt",
"sphinx_sitemap",
"docs.data_adapters_extension",
]
+# sphinx-llms-txt configuration
+llms_txt_title = "Apache Hamilton"
+llms_txt_summary = (
+ "Apache Hamilton is a lightweight Python framework for creating "
+ "DAGs of data transformations using declarative function definitions."
+)
+
nb_execution_mode = "off"
# this is required to get simplepdf to work
diff --git a/pyproject.toml b/pyproject.toml
index fe00b6b6..6f2bc943 100644
--- a/pyproject.toml
+++ b/pyproject.toml
@@ -131,8 +131,8 @@ test = [
]
docs = [
{include-group = "dev"},
- "alabaster>=0.7,<0.8,!=0.7.5", # read the docs pins
- "commonmark==0.9.1", # read the docs pins
+ "alabaster",
+ "commonmark",
"dask-expr>=1.1.14",
"dask[distributed]",
"ddtrace<3.0",
@@ -146,7 +146,7 @@ docs = [
"lxml",
"lz4",
"mlflow",
- "mock==1.0.1", # read the docs pins
+ "mock",
"myst-nb",
"narwhals",
"numpy",
@@ -159,14 +159,15 @@ docs = [
"pyspark",
"openlineage-python",
"PyYAML",
- "ray",
- "readthedocs-sphinx-ext<2.3", # read the docs pins
- "recommonmark==0.5.0", # read the docs pins
+ "ray; python_version < '3.14'",
+ "readthedocs-sphinx-ext",
+ "recommonmark",
"scikit-learn",
"slack-sdk",
- "sphinx", # unpinned because myst-parser doesn't break anymore
+ "sphinx",
"sphinx-autobuild",
- "sphinx-rtd-theme", # read the docs pins
+ "sphinx-llms-txt",
+ "sphinx-rtd-theme",
"sphinx-simplepdf",
"sphinx-sitemap",
"tqdm",
