An open API service indexing awesome lists of open source software.

https://github.com/jdillard/sphinx-llms-txt

llms.txt generator for Sphinx
https://github.com/jdillard/sphinx-llms-txt

sphinx-doc sphinx-extension

Last synced: 6 months ago
JSON representation

llms.txt generator for Sphinx

Awesome Lists containing this project

README

          

# Sphinx llms.txt generator

A Sphinx extension that generates a summary `llms.txt` file and a single combined documentation `llms-full.txt` file.

[![PyPI version](https://img.shields.io/pypi/v/sphinx-llms-txt.svg)](https://pypi.python.org/pypi/sphinx-llms-txt)
[![Conda Version](https://img.shields.io/conda/vn/conda-forge/sphinx-llms-txt.svg)](https://anaconda.org/conda-forge/sphinx-llms-txt)
[![Downloads](https://static.pepy.tech/badge/sphinx-llms-txt/month)](https://pepy.tech/project/sphinx-llms-txt)
[![Parallel Safe](https://img.shields.io/badge/parallel%20safe-true-brightgreen)](#)

## Documentation

See [sphinx-llms-txt documentation](https://sphinx-llms-txt.readthedocs.io/en/latest/index.html) for installation and configuration instructions.

## Contributing

Pull Requests welcome! See [Contributing](https://sphinx-llms-txt.readthedocs.io/en/latest/contributing.html) for instructions on how best to contribute.

## License

MIT License - see LICENSE file for details.