chore: Add llms.txt to documentation #6693
Open
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue number: #6692
Summary
Changes
Added missing requirements and run pip-compile.
This pull request updates the documentation build system by adding new dependencies, configuring plugins, and enhancing the
mkdocs.yml
file. The changes introduce new tools for generating and managing documentation content, including support for LLMs (Large Language Models) and Python docstring extraction.Dependency Updates:
mkdocstrings-python
andmkdocs-llmstxt
todocs/requirements.in
for Python docstring extraction and LLM-related functionality.docs/requirements.txt
to include new dependencies such asbeautifulsoup4
,griffe
,markdownify
,mkdocstrings
,mkdocs-autorefs
, and others, along with their respective hashes. These dependencies support enhanced documentation features like markdown processing, auto-references, and LLM integration. [1] [2] [3] [4] [5] [6] [7]mkdocs.yml
Enhancements:nav
) with links tollms.txt
and its full version.llmstxt
plugin with a detailed markdown description, output file paths, and organized sections for project documentation, core utilities, and processes.These updates streamline documentation generation and improve its structure, making it easier to maintain and extend.
User experience
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
Acknowledgment
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.
Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.