docs: add sphinx-llm to generate llms.txt and llms-full.txt#4279
Merged
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
Code Review
This pull request updates the Python version to 3.11 in the ReadTheDocs configuration, adds the sphinx-llm dependency to the documentation requirements, and includes sphinx_llm.txt in the Sphinx extensions list. There are no review comments to evaluate, and I have no additional feedback to provide.
Member
|
@luarss some conflicts need resolution |
Contributor
Author
|
ignore- |
Mirrors The-OpenROAD-Project/OpenROAD#10598. Adds sphinx-llm extension to Sphinx config and requirements, bumps Python to 3.11 in readthedocs. Signed-off-by: Jack Luar <jluar@precisioninno.com>
sphinx-llm was missing from requirements_lock.txt, causing the RTD build to fail. Revert python version to 3.10 to match the lock file generator and recompile to include sphinx-llm==0.4.1. Signed-off-by: Jack Luar <jluar@precisioninno.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Summary
Add support for
llms.txtandllms-full.txtto the ReadTheDocs documentation site using thesphinx-llmextension. These files follow the llmstxt.org standard and make OpenROAD-flow-scripts documentation directly consumable by LLMs without HTML scraping.Mirrors The-OpenROAD-Project/OpenROAD#10598.
Changes
docs/conf.py: addsphinx_llm.txtto the Sphinx extensions list — the extension generates both files as a native build step, writing directly into the HTML outputdocs/requirements.txt: addsphinx-llmOnce merged and built, files will be served at:
https://openroad-flow-scripts.readthedocs.io/llms.txthttps://openroad-flow-scripts.readthedocs.io/llms-full.txtTest plan
sphinx-llminstalled on Python 3.11llms.txtis accessible at the root of the ReadTheDocs site after build