API Reference

Config reference

Generated from add_config_value() registrations in sphinx_gp_llms/__init__.py.

llms_generate_txt

config none

config none

llms_generate_txt

Enable llms.txt generation.

Type:

bool

Default:

True

Registered by:

sphinx_gp_llms.setup()

llms_generate_full

config none

config none

llms_generate_full

Enable llms-full.txt generation.

Type:

bool

Default:

True

Registered by:

sphinx_gp_llms.setup()

llms_generate_json

config none

config none

llms_generate_json

Enable docs.json agent manifest generation.

Type:

bool

Default:

True

Registered by:

sphinx_gp_llms.setup()

llms_generate_md_twins

config none

config none

llms_generate_md_twins

Enable per-page .md twin file generation.

Type:

bool

Default:

True

Registered by:

sphinx_gp_llms.setup()

llms_txt_filename

config none

config none

llms_txt_filename

Output filename for the llms.txt index.

Type:

str

Default:

'llms.txt'

Registered by:

sphinx_gp_llms.setup()

llms_full_filename

config none

config none

llms_full_filename

Output filename for the concatenated full-content file.

Type:

str

Default:

'llms-full.txt'

Registered by:

sphinx_gp_llms.setup()

llms_json_filename

config none

config none

llms_json_filename

Output filename for the docs.json agent manifest.

Type:

str

Default:

'docs.json'

Registered by:

sphinx_gp_llms.setup()

llms_excludes

config none

config none

llms_excludes

fnmatch patterns matched against each page’s relative URL. Matched pages are excluded from all LLM outputs.

Type:

list

Default:

[]

Registered by:

sphinx_gp_llms.setup()

llms_description_length

config none

config none

llms_description_length

Maximum character length for page descriptions.

Type:

int

Default:

200

Registered by:

sphinx_gp_llms.setup()

Extension entry point

sphinx_gp_llms.setup(app)

function

function

sphinx_gp_llms.setup(app)

Register config values and connect build hooks.

Parameters:

app (Sphinx) – Sphinx application instance.

Returns:

Extension metadata with version and parallel-build flags.

Return type:

ExtensionMetadata

Examples

>>> from sphinx_gp_llms import setup
>>> callable(setup)
True