diff options
| author | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-06 22:54:56 +0300 |
|---|---|---|
| committer | Yuriy Andamasov <yuriy@vyos.io> | 2026-05-06 22:54:56 +0300 |
| commit | 8bfa3e59895716c872a2cbf4693e90094ed49ef5 (patch) | |
| tree | b2dea76ec706519c6b0353134f28ed49e4d48087 /docs/conf.py | |
| parent | 54f40acfb2a157fa001d44870454267a03f153bf (diff) | |
| download | vyos-documentation-8bfa3e59895716c872a2cbf4693e90094ed49ef5.tar.gz vyos-documentation-8bfa3e59895716c872a2cbf4693e90094ed49ef5.zip | |
docs(conf.py): clarify llms_txt_file comment points to _templates source
The pre-existing comment said "keep curated render via setup hook" but
didn't say where the source template lives. After moving llms.txt off
`html_extra_path` and onto a build-time render, point readers explicitly
at `_templates/llms.txt.j2` and `_write_llms_txt()` so future updates
land in the right place.
Addresses Copilot review feedback on PR #1874.
🤖 Generated by [robots](https://vyos.io)
Diffstat (limited to 'docs/conf.py')
| -rw-r--r-- | docs/conf.py | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/conf.py b/docs/conf.py index 99c4ee70..e9b28b71 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -118,8 +118,10 @@ html_baseurl = 'https://docs.vyos.io/en/rolling/' # sphinx-sitemap: baseurl already includes /en/rolling/, so skip lang+version sitemap_url_scheme = '{link}' -# sphinx-llms-txt: disable auto-generated llms.txt, keep curated render via -# setup hook; llms-full.txt is still auto-generated +# sphinx-llms-txt: disable the package's auto-generated index llms.txt. +# The curated llms.txt is rendered at build time from +# _templates/llms.txt.j2 by the _write_llms_txt() build-finished hook +# below; llms-full.txt is still auto-generated by sphinx-llms-txt. llms_txt_file = False # Custom sidebar templates, must be a dictionary that maps document names |