API Reference¶
Config reference¶
Generated from app.add_config_value() registrations in
sphinx_gp_llms/__init__.py.
-
llms_generate_txt¶llms_generate_txt¶
Enable llms.txt generation.
- Type:
bool- Default:
True- Registered by:
sphinx_gp_llms.setup()
-
llms_generate_full¶llms_generate_full¶
Enable llms-full.txt generation.
- Type:
bool- Default:
True- Registered by:
sphinx_gp_llms.setup()
-
llms_generate_json¶llms_generate_json¶
Enable docs.json agent manifest generation.
- Type:
bool- Default:
True- Registered by:
sphinx_gp_llms.setup()
-
llms_generate_md_twins¶llms_generate_md_twins¶
Enable per-page .md twin file generation.
- Type:
bool- Default:
True- Registered by:
sphinx_gp_llms.setup()
-
llms_txt_filename¶llms_txt_filename¶
Output filename for the llms.txt index.
- Type:
str- Default:
'llms.txt'- Registered by:
sphinx_gp_llms.setup()
-
llms_full_filename¶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¶llms_json_filename¶
Output filename for the docs.json agent manifest.
- Type:
str- Default:
'docs.json'- Registered by:
sphinx_gp_llms.setup()