diff --git a/CHANGELOG.md b/CHANGELOG.md index cb3076c..76fcc7b 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,10 @@ ## Unreleased +### Documentation + +- Expose an `llms.txt` file in the documentation [#111](https://github.com/python-backoff/backoff/pull/111) + ### Internal - Apply the Ruff `RET` rules [#92](https://github.com/python-backoff/backoff/pull/92) (from [@edgarrmondragon](https://github.com/edgarrmondragon)) diff --git a/mkdocs.yml b/mkdocs.yml index 569a891..cd50102 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,4 +1,5 @@ -site_url: https://backoff.readthedocs.io/ +# site_url: https://backoff.readthedocs.io/ +site_url: http://localhost:8000 site_description: Python library providing function decorators for configurable backoff and retry site_name: backoff repo_url: https://github.com/python-backoff/backoff @@ -43,6 +44,15 @@ plugins: docstring_style: google show_root_heading: yes show_source: yes + - llmstxt: + markdown_description: Python library providing function decorators for configurable backoff and retry. + full_output: llms-full.txt + sections: + Usage documentation: + - getting-started.md: Getting Started + - user-guide/*.md + API reference: + - api/reference.md nav: - Home: index.md - Getting Started: getting-started.md diff --git a/pyproject.toml b/pyproject.toml index 7c01424..0f68460 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -45,7 +45,8 @@ dev = [ { include-group = "typing" }, ] docs = [ - "mkdocstrings[python]~=1.0.2", + "mkdocstrings[python]==1.0.3", + "mkdocs-llmstxt==0.5.0", "zensical==0.0.23", ] lint = [ diff --git a/requirements/docs.requirements.txt b/requirements/docs.requirements.txt index 24ea100..2efec50 100644 --- a/requirements/docs.requirements.txt +++ b/requirements/docs.requirements.txt @@ -1,5 +1,9 @@ # This file was autogenerated by uv via the following command: # uv pip compile pyproject.toml --group=docs --python-version=3.14 --output-file=requirements/docs.requirements.txt +beautifulsoup4==4.14.3 + # via + # markdownify + # mkdocs-llmstxt click==8.3.1 # via # mkdocs @@ -29,12 +33,24 @@ markdown==3.10.2 # mkdocstrings # pymdown-extensions # zensical +markdown-it-py==3.0.0 + # via mdformat +markdownify==1.2.2 + # via mkdocs-llmstxt markupsafe==3.0.3 # via # jinja2 # mkdocs # mkdocs-autorefs # mkdocstrings +mdformat==0.7.22 + # via + # mdformat-tables + # mkdocs-llmstxt +mdformat-tables==1.0.0 + # via mkdocs-llmstxt +mdurl==0.1.2 + # via markdown-it-py mergedeep==1.3.4 # via # mkdocs @@ -49,6 +65,8 @@ mkdocs-autorefs==1.4.4 # mkdocstrings-python mkdocs-get-deps==0.2.0 # via mkdocs +mkdocs-llmstxt==0.5.0 + # via python-backoff (pyproject.toml:docs) mkdocstrings==1.0.3 # via # python-backoff (pyproject.toml:docs) @@ -79,8 +97,16 @@ pyyaml==6.0.3 pyyaml-env-tag==1.1 # via mkdocs six==1.17.0 - # via python-dateutil + # via + # markdownify + # python-dateutil +soupsieve==2.8.3 + # via beautifulsoup4 +typing-extensions==4.15.0 + # via beautifulsoup4 watchdog==6.0.0 # via mkdocs +wcwidth==0.6.0 + # via mdformat-tables zensical==0.0.23 # via python-backoff (pyproject.toml:docs)