summaryrefslogtreecommitdiff
path: root/docs/conf.py
diff options
context:
space:
mode:
authorYuriy Andamasov <yuriy@vyos.io>2026-04-14 13:19:06 +0300
committerGitHub <noreply@github.com>2026-04-14 11:19:06 +0100
commitf0402b1a08c393c6f12896e2d27c339030f030b2 (patch)
tree1d79a6d5adba5cc6e3a74c04c04aea5a033eda31 /docs/conf.py
parentac7620f61d58bd213b70ffa120e91cf421920d36 (diff)
downloadvyos-documentation-f0402b1a08c393c6f12896e2d27c339030f030b2.tar.gz
vyos-documentation-f0402b1a08c393c6f12896e2d27c339030f030b2.zip
feat: LLM documentation adaptation (llms.txt, sitemap, robots.txt) (#1832)
* feat: add sphinx-llms-txt and sphinx-sitemap dependencies Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * feat: register sphinx-llms-txt and sphinx-sitemap extensions Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * feat: add curated llms.txt for LLM discovery Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * feat: update robots.txt with explicit AI bot allowances Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> * fix: configure sphinx-llms-txt and sphinx-sitemap options Disable auto-generated llms.txt (curated version served from _html_extra instead). Set sitemap_url_scheme to avoid doubled lang/version path segments since html_baseurl already includes /en/latest/. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Diffstat (limited to 'docs/conf.py')
-rw-r--r--docs/conf.py13
1 files changed, 12 insertions, 1 deletions
diff --git a/docs/conf.py b/docs/conf.py
index e87def82..4d8f9f16 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -48,7 +48,9 @@ extensions = ['sphinx.ext.intersphinx',
'autosectionlabel',
'myst_parser',
'sphinx_design',
- 'vyos'
+ 'vyos',
+ 'sphinx_llms_txt',
+ 'sphinx_sitemap',
]
# Add any paths that contain templates here, relative to this directory.
@@ -111,6 +113,15 @@ html_static_path = ['_static']
html_extra_path = ['_html_extra']
+html_baseurl = 'https://docs.vyos.io/en/latest/'
+
+# sphinx-sitemap: baseurl already includes /en/latest/, so skip lang+version
+sitemap_url_scheme = '{link}'
+
+# sphinx-llms-txt: disable auto-generated llms.txt, keep curated one from
+# _html_extra; llms-full.txt is still auto-generated
+llms_txt_file = False
+
# Custom sidebar templates, must be a dictionary that maps document names
# to template names.
#