Skip to content

Commit 97b7b14

Browse files
authored
Add sphinx-llms-txt to contributing docs. (#2050)
- Fix sphinx-llms-txt warning from Sphinx
1 parent 65b0b4a commit 97b7b14

2 files changed

Lines changed: 10 additions & 2 deletions

File tree

docs/conf.py

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,14 @@
383383
todo_include_todos = True
384384

385385

386-
# -- Options for sphinx-notfound-page ----------------------------------
386+
# -- sphinx-llms-txt ----------------------------------
387+
llms_txt_exclude = [
388+
"search", # Exclude the search page
389+
"genindex", # Exclude the index page
390+
]
391+
392+
393+
# -- sphinx-notfound-page configuration ----------------------------------
387394

388395
notfound_urls_prefix = ""
389396
notfound_template = "404.html"
@@ -409,7 +416,7 @@
409416
}
410417

411418

412-
# -- Options for sphinx_sitemap to HTML -----------------------------
419+
# -- sphinx_sitemap configuration -----------------------------
413420

414421
# Used by sphinx_sitemap to generate a sitemap
415422
html_baseurl = "https://6.docs.plone.org/"

docs/contributing/documentation/themes-and-extensions.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,7 @@ We use several MyST and Sphinx extensions to enhance the presentation of Plone d
4545
- [`myst_parser`](https://myst-parser.readthedocs.io/en/latest/) parses MyST, a rich and extensible flavour of Markdown for authoring documentation.
4646
- [`sphinx-design`](https://sphinx-design.readthedocs.io/en/latest/), with a configuration name of `sphinx_design`, adds grids, cards, icons, badges, buttons, tabs, and dropdowns.
4747
- [`sphinx-examples`](https://ebp-sphinx-examples.readthedocs.io/en/latest/) adds "example snippets" that allow you to show off source Markdown and the result of rendering it in Sphinx.
48+
- [`sphinx-llms-txt`](https://sphinx-llms-txt.readthedocs.io/en/stable/) generates a summary {file}`llms.txt` file and a single combined documentation {file}`llms-full.txt` file.
4849
- [`sphinx-notfound-page`](https://sphinx-notfound-page.readthedocs.io/en/latest/index.html), with a configuration name of `notfound.extension`, creates a custom 404 page and helps generate proper static resource links to render the page.
4950
- [`sphinx-tippy`](https://sphinx-tippy.readthedocs.io/en/latest/), with a configuration name of `sphinx_tippy`, provides hover tips in your documentation.
5051
- [`sphinx.ext.autodoc`](https://www.sphinx-doc.org/en/master/usage/extensions/autodoc.html) pulls in documentation from Python docstrings to generate reStructuredText which in turn gets parsed by Sphinx and rendered to the output format.

0 commit comments

Comments
 (0)