Skip to main content

llms-full.txt generator for Sphinx

Project description

Sphinx llms-full.txt Extension

A Sphinx extension that creates a single combined documentation llms-full.txt file, written in reStructuredText.

Installation

pip install sphinx-llms-txt

Usage

  1. Add the extension to your Sphinx configuration (conf.py):
extensions = [
    'sphinx_llms_txt',
]

Configuration Options

llms_txt_filename

  • Type: string
  • Default: 'llms-full.txt'
  • Description: Name of the output file

llms_txt_verbose

  • Type: boolean
  • Default: False
  • Description: Whether to include a summary in the build output

License

MIT License - see LICENSE file for details.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

sphinx_llms_txt-0.1.0.tar.gz (5.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

sphinx_llms_txt-0.1.0-py3-none-any.whl (5.6 kB view details)

Uploaded Python 3

File details

Details for the file sphinx_llms_txt-0.1.0.tar.gz.

File metadata

  • Download URL: sphinx_llms_txt-0.1.0.tar.gz
  • Upload date:
  • Size: 5.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.3

File hashes

Hashes for sphinx_llms_txt-0.1.0.tar.gz
Algorithm Hash digest
SHA256 0cc3aa55351a017a952ba81ca8d1293d69d9d5b05edf61c2aa7cd7f3cc889d21
MD5 b1e0d4c3062936e71cd460ac53da6f03
BLAKE2b-256 7b31e2b9bac368781765bc2045153399c3cab55ad6572a2ea4fa130a3ac763ee

See more details on using hashes here.

File details

Details for the file sphinx_llms_txt-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for sphinx_llms_txt-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4e525748ae09ad1b182daf4875bdec09eab3d8e1f5b29a0a466bec405807b195
MD5 41fd735f76ad3118248747098d873684
BLAKE2b-256 6911fbc82f29ccaf85d3466f7c87f97139a6c94472c66e9b985567136e526c5f

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page