fw-sphinx

name	fw-sphinx
description	Use when generating or auditing documentation in Sphinx format — covers config, directory structure, frontmatter conventions, and build commands.

Sphinx Framework Adapter

Detection

Detected when conf.py exists and contains Sphinx-related configuration (e.g., extensions list, master_doc, or project variable).

Configuration Parsing

Key fields to extract from conf.py:

# conf.py
project = 'My Project'
extensions = [
    'sphinx.ext.autodoc',
    'sphinx.ext.napoleon',
    'sphinx.ext.viewcode',
]
master_doc = 'index'        # default: 'index'
source_suffix = '.rst'      # or ['.rst', '.md'] with MyST

• extensions: active Sphinx extensions (especially autodoc, napoleon)
• source_suffix: determines if docs are .rst, .md (MyST), or both
• master_doc: root document (default index)

Doc Root

Directory containing conf.py. Common patterns:

• docs/source/ (with docs/build/ for output)
• docs/ (flat layout)

Navigation: toctree

Sphinx uses directives for navigation: