Sphinx llms.txt Generator
=========================

A `Sphinx`_ extension that generates a summary ``llms.txt`` file, written in Markdown, and a single combined documentation ``llms-full.txt`` file, written in reStructuredText.

|PyPI version| |Conda Version| |Downloads| |Parallel Safe| |GitHub Stars|

Demo
----

You can see this Sphinx project's `llms.txt`_ and `llms-full.txt`_ files as a simple example.

Highlights
----------

1. **Content Collection**: Quickly gathers content from _sources, without needing a separate build
2. **Directive Processing**: Resolves ``include`` directives by automatically incorporating their content
3. **Path Resolution**: Transforms relative paths in directives to full paths
4. **Output Generation**: Creates two optional files:

   - ``llms.txt``: A concise summary of your documentation, in Markdown
   - ``llms-full.txt``: A comprehensive version with all documentation content, in reStructuredText

5. **Content Filtering**: Allows you to exclude specific pages or sections
6. **Source Code**: Allows you to include specific source code files

.. toctree::
   :maxdepth: 2

   getting-started
   advanced-configuration
   configuration-values
   contributing
   changelog


.. _llms.txt: https://sphinx-llms-txt.readthedocs.io/en/latest/llms.txt
.. _llms-full.txt: https://sphinx-llms-txt.readthedocs.io/en/latest/llms-full.txt
.. _Sphinx: http://sphinx-doc.org/

.. |PyPI version| image:: https://img.shields.io/pypi/v/sphinx-llms-txt.svg
   :target: https://pypi.python.org/pypi/sphinx-llms-txt
   :alt: Latest PyPi Version
.. |Conda Version| image:: https://img.shields.io/conda/vn/conda-forge/sphinx-llms-txt.svg
    :target: https://anaconda.org/conda-forge/sphinx-llms-txt
    :alt: Latest Conda Version
.. |Downloads| image:: https://static.pepy.tech/badge/sphinx-llms-txt/month
    :target: https://pepy.tech/project/sphinx-llms-txt
    :alt: PyPi Downloads per month
.. |Parallel Safe| image:: https://img.shields.io/badge/parallel%20safe-true-brightgreen
   :target: #
   :alt: Parallel read/write safe
.. |GitHub Stars| image:: https://img.shields.io/github/stars/jdillard/sphinx-llms-txt?style=social
   :target: https://github.com/jdillard/sphinx-llms-txt
   :alt: GitHub Repository stars