Xarkam/sphinx-llms-txt
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

add note about sphinx-llm

Browse Source
This commit is contained in:
Jared Dillard
2025-12-08 14:13:24 -08:00
parent 61f9b38d4d
commit 097f2c1084
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/source/getting-started.rst
+2 -1
View File
@@ -52,7 +52,7 @@ For optimal LLM support, see the alternative builders below and the :ref:`CMake
- reStructuredText - reStructuredText
* - **Setup** * - **Setup**
- No config - No config
- CMake - CMake [#sphinxllm]_
- CMake - CMake
* - **Builder** * - **Builder**
- Native [#native]_ - Native [#native]_
@@ -84,6 +84,7 @@ For optimal LLM support, see the alternative builders below and the :ref:`CMake
.. rubric:: Footnotes .. rubric:: Footnotes
.. [#sphinxllm] See `sphinx-llm <https://github.com/jacobtomlinson/sphinx-llm>`_ for CMake-free Markdown builds, note it may double build times due to serial execution.
.. [#native] Uses raw :confval:`_sources/ <sphinx:html_copy_source>` files created by Sphinx's HTML builder with some minor enhancements. .. [#native] Uses raw :confval:`_sources/ <sphinx:html_copy_source>` files created by Sphinx's HTML builder with some minor enhancements.
.. [#autodoc] Directives like ``autodoc`` will appear as raw directive syntax rather than the extracted docstrings. .. [#autodoc] Directives like ``autodoc`` will appear as raw directive syntax rather than the extracted docstrings.
.. [#pending] PRs that add ``llms-full.txt`` concatenation support have yet to be released. .. [#pending] PRs that add ``llms-full.txt`` concatenation support have yet to be released.