{ "name": "gp-sphinx", "url": "https://gp-sphinx.git-pull.com", "description": "Integrated autodoc design system for git-pull Sphinx projects.", "sourceRepository": "https://github.com/git-pull/gp-sphinx/", "agentEntrypoints": { "manifest": "/docs.json", "llms": "/llms.txt", "llmsFull": "/llms-full.txt" }, "pages": [ { "title": "API Reference", "description": "Public API for building Sphinx configurations and source link resolvers.", "section": "Documentation", "url": "/api/", "markdownUrl": "/api.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "merge-sphinx-config", "level": 2, "text": "merge_sphinx_config" }, { "id": "gp_sphinx.config.merge_sphinx_config", "level": 3, "text": "merge_sphinx_config()" }, { "id": "make-linkcode-resolve", "level": 2, "text": "make_linkcode_resolve" }, { "id": "gp_sphinx.config.make_linkcode_resolve", "level": 3, "text": "make_linkcode_resolve()" }, { "id": "wiring-into-conf-py", "level": 3, "text": "Wiring into conf.py" }, { "id": "deep-merge", "level": 2, "text": "deep_merge" }, { "id": "gp_sphinx.config.deep_merge", "level": 3, "text": "deep_merge()" }, { "id": "setup", "level": 2, "text": "setup" }, { "id": "gp_sphinx.config.setup", "level": 3, "text": "setup()" }, { "id": "skip-machinery-members", "level": 2, "text": "skip_machinery_members" }, { "id": "gp_sphinx.config.skip_machinery_members", "level": 3, "text": "skip_machinery_members()" }, { "id": "gp_sphinx.config.MACHINERY_MEMBERS", "level": 3, "text": "MACHINERY_MEMBERS" } ] }, { "title": "Architecture", "description": "Workspace packages organized in tiers. Lower layers never depend on higher ones — autodoc extensions consume shared infrastructure, and the presentation layer wires everything together for downstr...", "section": "Documentation", "url": "/architecture/", "markdownUrl": "/architecture.md", "headings": [ { "id": "", "level": 1, "text": "Architecture" }, { "id": "tier-1-shared-infrastructure", "level": 2, "text": "Tier 1: Shared infrastructure" }, { "id": "tier-2-autodoc-extensions", "level": 2, "text": "Tier 2: Autodoc extensions" }, { "id": "tier-3-theme-and-coordinator", "level": 2, "text": "Tier 3: Theme and coordinator" }, { "id": "build-tooling", "level": 2, "text": "Build tooling" }, { "id": "how-the-tiers-connect", "level": 2, "text": "How the tiers connect" } ] }, { "title": "Configuration", "description": "Reference for gp_sphinx.config.merge_sphinx_config() and the shared defaults it applies.", "section": "Documentation", "url": "/configuration/", "markdownUrl": "/configuration.md", "headings": [ { "id": "", "level": 1, "text": "Configuration" }, { "id": "integration-pattern", "level": 2, "text": "Integration pattern" }, { "id": "merge-sphinx-config-parameters", "level": 2, "text": "merge_sphinx_config() parameters" }, { "id": "auto-computed-values", "level": 2, "text": "Auto-computed values" }, { "id": "from-source-repository", "level": 3, "text": "From source_repository" }, { "id": "from-docs-url", "level": 3, "text": "From docs_url" }, { "id": "from-overrides", "level": 3, "text": "From **overrides" }, { "id": "injected-setup-app", "level": 2, "text": "Injected setup(app)" }, { "id": "always-set-coordinator-values", "level": 2, "text": "Always-set coordinator values" }, { "id": "shared-default-constants", "level": 2, "text": "Shared DEFAULT_* constants" }, { "id": "extensions-and-source-parsing", "level": 3, "text": "Extensions and source parsing" }, { "id": "theme-defaults", "level": 3, "text": "Theme defaults" }, { "id": "font-defaults", "level": 3, "text": "Font defaults" }, { "id": "syntax-highlighting-and-copybutton", "level": 3, "text": "Syntax highlighting and copybutton" }, { "id": "autodoc-defaults", "level": 3, "text": "Autodoc defaults" }, { "id": "warning-defaults", "level": 3, "text": "Warning defaults" }, { "id": "parameter-interactions", "level": 2, "text": "Parameter interactions" } ] }, { "title": "Gallery", "description": "Every example on this page is rendered live from the same extensions and theme your project gets out of the box. Nothing is mocked — the output below is the real autodoc pipeline.", "section": "Documentation", "url": "/gallery/", "markdownUrl": "/gallery.md", "headings": [ { "id": "", "level": 1, "text": "Gallery" }, { "id": "python-api", "level": 2, "text": "Python API" }, { "id": "functions", "level": 3, "text": "Functions" }, { "id": "module-data", "level": 3, "text": "Module data" }, { "id": "exceptions", "level": 3, "text": "Exceptions" }, { "id": "classes", "level": 3, "text": "Classes" }, { "id": "abstract-base-classes", "level": 3, "text": "Abstract base classes" }, { "id": "layout-regions-and-parameter-folding", "level": 2, "text": "Layout regions and parameter folding" }, { "id": "class-with-members-regions-fold", "level": 3, "text": "Class with members (regions + fold)" }, { "id": "small-function-no-fold", "level": 3, "text": "Small function (no fold)" }, { "id": "badge-palette", "level": 2, "text": "Badge palette" }, { "id": "fastmcp-tool-cards", "level": 2, "text": "FastMCP tool cards" }, { "id": "fastmcp-tool-list-sessions", "level": 3, "text": "list_sessions" }, { "id": "fastmcp-tool-create-session", "level": 3, "text": "create_session" }, { "id": "fastmcp-tool-delete-session", "level": 3, "text": "delete_session" }, { "id": "parameter-table", "level": 3, "text": "Parameter table" }, { "id": "tool-summary", "level": 3, "text": "Tool summary" }, { "id": "inspect", "level": 4, "text": "Inspect" }, { "id": "act", "level": 4, "text": "Act" }, { "id": "destroy", "level": 4, "text": "Destroy" }, { "id": "pytest-fixtures", "level": 2, "text": "pytest fixtures" }, { "id": "fixture-reference", "level": 3, "text": "Fixture reference" }, { "id": "sphinx-config-values", "level": 2, "text": "Sphinx config values" }, { "id": "docutils-directives-and-roles", "level": 2, "text": "docutils directives and roles" }, { "id": "directives", "level": 3, "text": "Directives" }, { "id": "roles", "level": 3, "text": "Roles" } ] }, { "title": "Changelog", "description": "To install the unreleased gp-sphinx version, see developmental releases.", "section": "Documentation", "url": "/history/", "markdownUrl": "/history.md", "headings": [ { "id": "", "level": 1, "text": "Changelog" }, { "id": "gp-sphinx-0-1-0a38-unreleased", "level": 2, "text": "gp-sphinx 0.1.0a38 (unreleased)" }, { "id": "gp-sphinx-0-1-0a37-2026-07-26", "level": 2, "text": "gp-sphinx 0.1.0a37 (2026-07-26)" }, { "id": "breaking-changes", "level": 3, "text": "Breaking changes" }, { "id": "an-undescribed-class-variable-is-withheld-from-the-reference", "level": 4, "text": "An undescribed class variable is withheld from the reference" }, { "id": "what-s-new", "level": 3, "text": "What’s new" }, { "id": "a-description-written-on-the-base-reaches-every-subclass", "level": 4, "text": "A description written on the base reaches every subclass" }, { "id": "module-constants-render-their-value", "level": 4, "text": "Module constants render their value" }, { "id": "machinery-members-stay-off-the-page", "level": 4, "text": "Machinery members stay off the page" }, { "id": "fixes", "level": 3, "text": "Fixes" }, { "id": "a-described-member-keeps-its-description", "level": 4, "text": "A described member keeps its description" }, { "id": "a-described-member-keeps-its-signature", "level": 4, "text": "A described member keeps its signature" }, { "id": "documenting-a-typed-dictionary-keeps-its-subclasses-keys", "level": 4, "text": "Documenting a typed dictionary keeps its subclasses’ keys" }, { "id": "documentation", "level": 3, "text": "Documentation" }, { "id": "class-level-names-have-a-how-to", "level": 4, "text": "Class-level names have a how-to" }, { "id": "more-fields-describe-themselves-in-the-api-reference", "level": 4, "text": "More fields describe themselves in the API reference" }, { "id": "development", "level": 3, "text": "Development" }, { "id": "lint-toolchain-ruff-0-16", "level": 4, "text": "Lint toolchain: ruff 0.16" }, { "id": "gp-sphinx-0-0-1a36-2026-07-26", "level": 2, "text": "gp-sphinx 0.0.1a36 (2026-07-26)" }, { "id": "id1", "level": 3, "text": "Fixes" }, { "id": "sphinx-autodoc-typehints-gp-declared-fields-described-once", "level": 4, "text": "sphinx-autodoc-typehints-gp: Declared fields described once" }, { "id": "id2", "level": 3, "text": "Documentation" }, { "id": "class-fields-describe-themselves-in-the-api-reference", "level": 4, "text": "Class fields describe themselves in the API reference" }, { "id": "id3", "level": 3, "text": "Development" }, { "id": "ci-actions-updated-to-current-majors", "level": 4, "text": "CI actions updated to current majors" }, { "id": "gp-sphinx-0-0-1a35-2026-07-19", "level": 2, "text": "gp-sphinx 0.0.1a35 (2026-07-19)" }, { "id": "id4", "level": 3, "text": "Fixes" }, { "id": "sidebar-highlights-the-most-specific-project-link", "level": 4, "text": "Sidebar highlights the most specific project link" }, { "id": "gp-sphinx-0-0-1a34-2026-07-13", "level": 2, "text": "gp-sphinx 0.0.1a34 (2026-07-13)" }, { "id": "id5", "level": 3, "text": "What’s new" }, { "id": "hide-hide-doctest-setup-from-rendered-docs", "level": 4, "text": "Hide +HIDE doctest setup from rendered docs" }, { "id": "id6", "level": 3, "text": "Fixes" }, { "id": "sphinx-autodoc-api-style-modifier-no-longer-renders-twice", "level": 4, "text": "sphinx-autodoc-api-style: Modifier no longer renders twice" }, { "id": "gp-sphinx-0-0-1a33-2026-07-05", "level": 2, "text": "gp-sphinx 0.0.1a33 (2026-07-05)" }, { "id": "id7", "level": 3, "text": "What’s new" }, { "id": "responsive-mermaid-diagrams", "level": 4, "text": "Responsive Mermaid diagrams" }, { "id": "code-highlighting-for-trees-commands-and-paths", "level": 4, "text": "Code highlighting for trees, commands, and paths" }, { "id": "gp-sphinx-0-0-1a32-2026-07-04", "level": 2, "text": "gp-sphinx 0.0.1a32 (2026-07-04)" }, { "id": "id8", "level": 3, "text": "What’s new" }, { "id": "new-package-sphinx-gp-mermaid", "level": 4, "text": "New package: sphinx-gp-mermaid" }, { "id": "gp-sphinx-0-0-1a31-2026-06-15", "level": 2, "text": "gp-sphinx 0.0.1a31 (2026-06-15)" }, { "id": "id9", "level": 3, "text": "What’s new" }, { "id": "cross-reference-roles-for-resources-and-prompts", "level": 4, "text": "Cross-reference roles for resources and prompts" }, { "id": "no-index-for-components-shown-on-more-than-one-page", "level": 4, "text": ":no-index: for components shown on more than one page" }, { "id": "gp-sphinx-0-0-1a30-2026-06-07", "level": 2, "text": "gp-sphinx 0.0.1a30 (2026-06-07)" }, { "id": "id10", "level": 3, "text": "Fixes" }, { "id": "type-chips-in-parameter-lists-regain-their-padding", "level": 4, "text": "Type chips in parameter lists regain their padding" }, { "id": "gp-sphinx-0-0-1a29-2026-06-07", "level": 2, "text": "gp-sphinx 0.0.1a29 (2026-06-07)" }, { "id": "id11", "level": 3, "text": "What’s new" }, { "id": "autodoc-for-docutils-components", "level": 4, "text": "Autodoc for docutils components" }, { "id": "autodoc-for-sphinx-builders-and-domains", "level": 4, "text": "Autodoc for Sphinx builders and domains" }, { "id": "cross-reference-roles-for-documented-components", "level": 4, "text": "Cross-reference roles for documented components" }, { "id": "id12", "level": 3, "text": "Fixes" }, { "id": "code-comments-no-longer-trigger-a-font-swap-on-first-paint", "level": 4, "text": "Code comments no longer trigger a font swap on first paint" }, { "id": "gp-sphinx-0-0-1a28-2026-06-07", "level": 2, "text": "gp-sphinx 0.0.1a28 (2026-06-07)" }, { "id": "id13", "level": 3, "text": "Development" }, { "id": "js-toolchain-zod-4-vitest-4-typescript-6-tailwind-css-4-3-vite-8", "level": 4, "text": "JS toolchain: Zod 4, Vitest 4, TypeScript 6, Tailwind CSS 4.3, Vite 8" }, { "id": "theme-assets-browser-floor-is-now-baseline-widely-available", "level": 4, "text": "Theme assets: browser floor is now Baseline Widely Available" }, { "id": "gp-sphinx-0-0-1a27-2026-06-06", "level": 2, "text": "gp-sphinx 0.0.1a27 (2026-06-06)" }, { "id": "id14", "level": 3, "text": "Fixes" }, { "id": "sphinx-autodoc-fastmcp-no-duplicate-ids-when-a-page-heading-matches-a-tool-slug", "level": 4, "text": "sphinx-autodoc-fastmcp: No duplicate IDs when a page heading matches a tool slug" }, { "id": "gp-sphinx-0-0-1a26-2026-05-25", "level": 2, "text": "gp-sphinx 0.0.1a26 (2026-05-25)" }, { "id": "id15", "level": 3, "text": "Fixes" }, { "id": "gp-sphinx-0-0-1a25-2026-05-25", "level": 2, "text": "gp-sphinx 0.0.1a25 (2026-05-25)" }, { "id": "id16", "level": 3, "text": "Fixes" }, { "id": "gp-sphinx-0-0-1a24-2026-05-25", "level": 2, "text": "gp-sphinx 0.0.1a24 (2026-05-25)" }, { "id": "id17", "level": 3, "text": "What’s new" }, { "id": "source-file-path-in-page-footer", "level": 4, "text": "Source-file path in page footer" }, { "id": "llm-friendly-documentation-outputs", "level": 4, "text": "LLM-friendly documentation outputs" }, { "id": "autoconfigvalues-exclude-option", "level": 4, "text": "autoconfigvalues :exclude: option" }, { "id": "gp-sphinx-0-0-1a23-2026-05-24", "level": 2, "text": "gp-sphinx 0.0.1a23 (2026-05-24)" }, { "id": "gp-sphinx-0-0-1a22-2026-05-24", "level": 2, "text": "gp-sphinx 0.0.1a22 (2026-05-24)" }, { "id": "id18", "level": 3, "text": "Fixes" }, { "id": "sphinx-ux-autodoc-layout-anchor-targets-scroll-to-viewport-top-not-center", "level": 4, "text": "sphinx-ux-autodoc-layout: Anchor targets scroll to viewport top, not center" }, { "id": "gp-sphinx-0-0-1a21-2026-05-23", "level": 2, "text": "gp-sphinx 0.0.1a21 (2026-05-23)" }, { "id": "id19", "level": 3, "text": "Fixes" }, { "id": "sphinx-ux-autodoc-layout-collapsed-api-sections-expand-on-spa-navigation", "level": 4, "text": "sphinx-ux-autodoc-layout: Collapsed API sections expand on SPA navigation" }, { "id": "gp-sphinx-0-0-1a20-2026-05-17", "level": 2, "text": "gp-sphinx 0.0.1a20 (2026-05-17)" }, { "id": "id20", "level": 3, "text": "Fixes" }, { "id": "sidebar-logo-loads-as-a-critical-path-resource", "level": 4, "text": "Sidebar logo loads as a critical-path resource" }, { "id": "id21", "level": 3, "text": "Documentation" }, { "id": "visual-identity-for-the-gp-sphinx-docs-site", "level": 4, "text": "Visual identity for the gp-sphinx docs site" }, { "id": "gp-sphinx-0-0-1a19-2026-05-17", "level": 2, "text": "gp-sphinx 0.0.1a19 (2026-05-17)" }, { "id": "id22", "level": 3, "text": "Fixes" }, { "id": "cloudflare-rocket-loader-compatibility-on-bundled-theme-scripts", "level": 4, "text": "Cloudflare Rocket Loader compatibility on bundled theme scripts" }, { "id": "gp-sphinx-0-0-1a18-2026-05-10", "level": 2, "text": "gp-sphinx 0.0.1a18 (2026-05-10)" }, { "id": "id23", "level": 3, "text": "What’s new" }, { "id": "gp-sphinx-curated-default-value-rendering-for-autodoc", "level": 4, "text": "gp-sphinx: Curated default-value rendering for autodoc" }, { "id": "sphinx-autodoc-typehints-gp-canonical-python-xrefs-in-field-lists", "level": 4, "text": "sphinx-autodoc-typehints-gp: Canonical Python xrefs in field lists" }, { "id": "autodoc-typography-polish-across-the-docs-surface", "level": 4, "text": "Autodoc typography polish across the docs surface" }, { "id": "gp-sphinx-workspace-wide-linkcode-resolve-factory", "level": 4, "text": "gp-sphinx: Workspace-wide linkcode_resolve factory" }, { "id": "sphinx-ux-autodoc-layout-responsive-autodoc-headers-on-narrow-viewports", "level": 4, "text": "sphinx-ux-autodoc-layout: Responsive autodoc headers on narrow viewports" }, { "id": "bug-fixes", "level": 3, "text": "Bug fixes" }, { "id": "sphinx-gp-theme-toc-font-size-override-now-applies", "level": 4, "text": "sphinx-gp-theme: TOC font-size override now applies" }, { "id": "sphinx-ux-autodoc-layout-mobile-header-keeps-the-type-badge-beside-the-signature", "level": 4, "text": "sphinx-ux-autodoc-layout: Mobile header keeps the type badge beside the signature" }, { "id": "sphinx-vite-builder-ci-setup-hint-no-longer-requires-a-root-lockfile", "level": 4, "text": "sphinx-vite-builder: CI setup hint no longer requires a root lockfile" }, { "id": "gp-sphinx-0-0-1a17-2026-05-09", "level": 2, "text": "gp-sphinx 0.0.1a17 (2026-05-09)" }, { "id": "id24", "level": 3, "text": "What’s new" }, { "id": "gp-sphinx-default-font-preload-list-now-covers-heading-italic-and-bold-code-fout", "level": 4, "text": "gp-sphinx: Default font-preload list now covers heading, italic, and bold-code FOUT" }, { "id": "id25", "level": 3, "text": "Bug fixes" }, { "id": "gp-sphinx-mystlexer-highlights-directive-colon-fences", "level": 4, "text": "gp-sphinx: MystLexer highlights :::{directive} colon-fences" }, { "id": "id26", "level": 3, "text": "Documentation" }, { "id": "per-package-documentation-tree", "level": 4, "text": "Per-package documentation tree" }, { "id": "showcase-opt-in-directives", "level": 4, "text": "Showcase opt-in directives" }, { "id": "gp-sphinx-0-0-1a16-2026-05-03", "level": 2, "text": "gp-sphinx 0.0.1a16 (2026-05-03)" }, { "id": "id27", "level": 3, "text": "What’s new" }, { "id": "new-package-sphinx-vite-builder", "level": 4, "text": "New package: sphinx-vite-builder" }, { "id": "id28", "level": 3, "text": "Bug fixes" }, { "id": "gp-furo-theme-wheels-now-ship-with-vite-built-css-and-js", "level": 4, "text": "gp-furo-theme: Wheels now ship with vite-built CSS and JS" }, { "id": "gp-sphinx-0-0-1a15-2026-05-02", "level": 2, "text": "gp-sphinx 0.0.1a15 (2026-05-02)" }, { "id": "id29", "level": 3, "text": "What’s new" }, { "id": "theme-workspace-owned-port-of-furo", "level": 4, "text": "Theme: workspace-owned port of Furo" }, { "id": "new-package-gp-furo-theme", "level": 4, "text": "New package: gp-furo-theme" }, { "id": "new-package-gp-sphinx-vite", "level": 4, "text": "New package: gp-sphinx-vite" }, { "id": "gp-sphinx-0-0-1a14-2026-05-02", "level": 2, "text": "gp-sphinx 0.0.1a14 (2026-05-02)" }, { "id": "id30", "level": 3, "text": "Bug fixes" }, { "id": "sphinx-gp-theme-light-mode-shell-prompts-and-command-output-now-visually-distinct", "level": 4, "text": "sphinx-gp-theme: Light-mode shell prompts and command output now visually distinct" }, { "id": "gp-sphinx-0-0-1a13-2026-04-30", "level": 2, "text": "gp-sphinx 0.0.1a13 (2026-04-30)" }, { "id": "id31", "level": 3, "text": "What’s new" }, { "id": "sphinx-gp-theme-light-mode-code-blocks-now-render-with-a-light-palette", "level": 4, "text": "sphinx-gp-theme: Light-mode code blocks now render with a light palette" }, { "id": "id32", "level": 3, "text": "Bug fixes" }, { "id": "sphinx-gp-theme-argparse-directives-now-follow-the-active-theme", "level": 4, "text": "sphinx-gp-theme: argparse directives now follow the active theme" }, { "id": "gp-sphinx-0-0-1a12-2026-04-27", "level": 2, "text": "gp-sphinx 0.0.1a12 (2026-04-27)" }, { "id": "id33", "level": 3, "text": "Bug fixes" }, { "id": "sphinx-gp-theme-sidebar-logo-no-longer-disappears-on-ios-safari-during-navigation", "level": 4, "text": "sphinx-gp-theme: Sidebar logo no longer disappears on iOS Safari during navigation" }, { "id": "gp-sphinx-0-0-1a11-2026-04-26", "level": 2, "text": "gp-sphinx 0.0.1a11 (2026-04-26)" }, { "id": "id34", "level": 3, "text": "Bug fixes" }, { "id": "gp-sphinx-no-more-theme-flicker-on-initial-load-or-toggle", "level": 4, "text": "gp-sphinx: No more theme flicker on initial load or toggle" }, { "id": "gp-sphinx-0-0-1a10-2026-04-25", "level": 2, "text": "gp-sphinx 0.0.1a10 (2026-04-25)" }, { "id": "id35", "level": 3, "text": "Breaking changes" }, { "id": "id36", "level": 3, "text": "What’s new" }, { "id": "new-package-gp-sphinx", "level": 4, "text": "New package: gp-sphinx" }, { "id": "new-package-sphinx-gp-opengraph", "level": 4, "text": "New package: sphinx-gp-opengraph" }, { "id": "new-package-sphinx-gp-sitemap", "level": 4, "text": "New package: sphinx-gp-sitemap" }, { "id": "new-package-sphinx-fonts", "level": 4, "text": "New package: sphinx-fonts" }, { "id": "new-package-sphinx-gp-theme", "level": 4, "text": "New package: sphinx-gp-theme" }, { "id": "new-package-sphinx-autodoc-argparse", "level": 4, "text": "New package: sphinx-autodoc-argparse" }, { "id": "new-package-sphinx-autodoc-pytest-fixtures", "level": 4, "text": "New package: sphinx-autodoc-pytest-fixtures" }, { "id": "new-package-sphinx-ux-badges", "level": 4, "text": "New package: sphinx-ux-badges" }, { "id": "new-package-sphinx-ux-autodoc-layout", "level": 4, "text": "New package: sphinx-ux-autodoc-layout" }, { "id": "new-package-sphinx-autodoc-typehints-gp", "level": 4, "text": "New package: sphinx-autodoc-typehints-gp" }, { "id": "new-package-sphinx-autodoc-fastmcp", "level": 4, "text": "New package: sphinx-autodoc-fastmcp" }, { "id": "gp-sphinx-integrated-autodoc-design-system", "level": 4, "text": "gp-sphinx: Integrated autodoc design system" }, { "id": "gp-sphinx-seo-config-auto-wired-from-docs-url", "level": 4, "text": "gp-sphinx: SEO config auto-wired from docs_url" }, { "id": "sphinx-autodoc-docutils-register-aware-directive-and-role-discovery", "level": 4, "text": "sphinx-autodoc-docutils: Register-aware directive and role discovery" }, { "id": "sphinx-autodoc-argparse-new-argparse-sphinx-domain", "level": 4, "text": "sphinx-autodoc-argparse: New argparse Sphinx domain" }, { "id": "sphinx-ux-badges-shared-badge-surface", "level": 4, "text": "sphinx-ux-badges: Shared badge surface" }, { "id": "sphinx-autodoc-pytest-fixtures-typealias-resolution", "level": 4, "text": "sphinx-autodoc-pytest-fixtures: TypeAlias resolution" }, { "id": "sphinx-gp-theme-gp-sphinx-navigated-event-after-spa-nav", "level": 4, "text": "sphinx-gp-theme: gp-sphinx:navigated event after SPA nav" }, { "id": "id37", "level": 3, "text": "Bug fixes" }, { "id": "sphinx-gp-opengraph-xhtml-self-closing-void-tags-no-longer-drop-trailing-title-text", "level": 4, "text": "sphinx-gp-opengraph: XHTML self-closing void tags no longer drop trailing title text" }, { "id": "sphinx-gp-opengraph-html-escape-every-meta-tag-attribute", "level": 4, "text": "sphinx-gp-opengraph: HTML-escape every meta-tag attribute" }, { "id": "gp-sphinx-preserve-docs-url-path-component-in-derived-urls", "level": 4, "text": "gp-sphinx: Preserve docs_url path component in derived URLs" }, { "id": "sphinx-gp-sitemap-complete-sitemap-on-incremental-and-parallel-builds", "level": 4, "text": "sphinx-gp-sitemap: Complete sitemap on incremental and parallel builds" }, { "id": "sphinx-autodoc-docutils-surface-failed-setup-replay-in-build-log", "level": 4, "text": "sphinx-autodoc-docutils: Surface failed setup() replay in build log" }, { "id": "sphinx-autodoc-fastmcp-section-labels-resolve-by-component-name", "level": 4, "text": "sphinx-autodoc-fastmcp: Section labels resolve by component name" }, { "id": "sphinx-autodoc-fastmcp-decorator-registered-components-no-longer-dropped", "level": 4, "text": "sphinx-autodoc-fastmcp: Decorator-registered components no longer dropped" }, { "id": "sphinx-autodoc-fastmcp-surface-real-import-failures", "level": 4, "text": "sphinx-autodoc-fastmcp: Surface real import failures" }, { "id": "sphinx-autodoc-typehints-gp-exc-references-with-mod-foo-shorten-to-foo", "level": 4, "text": "sphinx-autodoc-typehints-gp: :exc: references with ~mod.Foo shorten to Foo" }, { "id": "sphinx-autodoc-typehints-gp-raises-type-fields-preserve-parameterised-generics", "level": 4, "text": "sphinx-autodoc-typehints-gp: Raises type fields preserve parameterised generics" }, { "id": "sphinx-autodoc-typehints-gp-empty-examples-references-sections-render-their-rubric", "level": 4, "text": "sphinx-autodoc-typehints-gp: Empty Examples / References sections render their rubric" }, { "id": "sphinx-gp-theme-spa-nav-scrolls-to-anchor-on-cross-page-fragments", "level": 4, "text": "sphinx-gp-theme: SPA nav scrolls to anchor on cross-page fragments" }, { "id": "sphinx-gp-theme-copy-buttons-survive-spa-navigation", "level": 4, "text": "sphinx-gp-theme: Copy buttons survive SPA navigation" }, { "id": "sphinx-fonts-full-weight-range-for-ibm-plex-sans-and-mono", "level": 4, "text": "sphinx-fonts: Full weight range for IBM Plex Sans and Mono" }, { "id": "sphinx-ux-badges-restore-background-border-and-tooltip-styling", "level": 4, "text": "sphinx-ux-badges: Restore background, border, and tooltip styling" }, { "id": "sphinx-autodoc-argparse-no-more-duplicate-label-warnings-on-multi-page-docs", "level": 4, "text": "sphinx-autodoc-argparse: No more duplicate label warnings on multi-page docs" } ] }, { "title": "gp-sphinx", "description": "Integrated autodoc design system for git-pull Sphinx projects.", "section": "", "url": "/", "markdownUrl": "/index.md", "headings": [ { "id": "", "level": 1, "text": "gp-sphinx" }, { "id": "install", "level": 2, "text": "Install" }, { "id": "at-a-glance", "level": 2, "text": "At a glance" }, { "id": "what-you-get", "level": 2, "text": "What you get" } ] }, { "title": "@gp-sphinx/furo-tokens", "description": "Unknown GitHub npm", "section": "Tokens", "url": "/packages/@gp-sphinx/furo-tokens/", "markdownUrl": "/packages/@gp-sphinx/furo-tokens/index.md", "headings": [ { "id": "", "level": 1, "text": "@gp-sphinx/furo-tokens" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a gp-furo-theme dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/gp-furo-theme/dependents/", "markdownUrl": "/packages/gp-furo-theme/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "How to", "description": "Use gp-furo-theme when you want the git-pull Tailwind port of Furo directly, outside the coordinator defaults that /packages/gp-sphinx/index supplies.", "section": "Documentation", "url": "/packages/gp-furo-theme/how-to/", "markdownUrl": "/packages/gp-furo-theme/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "css-authoring-layout", "level": 2, "text": "CSS authoring layout" }, { "id": "visual-fidelity", "level": 2, "text": "Visual fidelity" }, { "id": "attribution", "level": 2, "text": "Attribution" } ] }, { "title": "gp-furo-theme", "description": "Alpha GitHub PyPI", "section": "Theme & coordinator", "url": "/packages/gp-furo-theme/", "markdownUrl": "/packages/gp-furo-theme/index.md", "headings": [ { "id": "", "level": 1, "text": "gp-furo-theme" } ] }, { "title": "API Reference", "description": "Generated from add_config_value() registrations in gp_furo_theme/__init__.py.", "section": "Documentation", "url": "/packages/gp-furo-theme/reference/", "markdownUrl": "/packages/gp-furo-theme/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-pygments_dark_style", "level": 3, "text": "pygments_dark_style" }, { "id": "theme-helpers", "level": 2, "text": "Theme helpers" }, { "id": "gp_furo_theme.get_theme_path", "level": 3, "text": "get_theme_path()" }, { "id": "gp_furo_theme.setup", "level": 3, "text": "setup()" }, { "id": "gp_furo_theme.navigation.get_navigation_tree", "level": 3, "text": "get_navigation_tree()" } ] }, { "title": "Signatures (live)", "description": "Public callables in gp_furo_theme rendered from the running interpreter at docs-build time. Drift between this block and the prose elsewhere on the page indicates a stale docstring or signature com...", "section": "Documentation", "url": "/packages/gp-furo-theme/signatures/", "markdownUrl": "/packages/gp-furo-theme/signatures.md", "headings": [ { "id": "", "level": 1, "text": "Signatures (live)" } ] }, { "title": "How to", "description": "Use the coordinator when a downstream project wants the shared theme, extensions, fonts, SEO defaults, and workspace conventions from one docs/conf.py call.", "section": "Documentation", "url": "/packages/gp-sphinx/how-to/", "markdownUrl": "/packages/gp-sphinx/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "what-it-injects", "level": 2, "text": "What it injects" }, { "id": "seo-emission-for-free", "level": 2, "text": "SEO emission for free" } ] }, { "title": "gp-sphinx", "description": "Alpha GitHub PyPI", "section": "Theme & coordinator", "url": "/packages/gp-sphinx/", "markdownUrl": "/packages/gp-sphinx/index.md", "headings": [ { "id": "", "level": 1, "text": "gp-sphinx" } ] }, { "title": "Packages", "description": "The workspace ships independently-installable Sphinx packages organized by family. Each package has its own page; the grid below auto-enumerates the full set as the workspace evolves.", "section": "Documentation", "url": "/packages/", "markdownUrl": "/packages/index.md", "headings": [ { "id": "", "level": 1, "text": "Packages" }, { "id": "common-libraries", "level": 2, "text": "Common libraries" }, { "id": "code-highlighting", "level": 2, "text": "Code highlighting" }, { "id": "autodoc-extensions", "level": 2, "text": "Autodoc extensions" }, { "id": "build-utils", "level": 2, "text": "Build utils" }, { "id": "theme-and-coordinator", "level": 2, "text": "Theme and coordinator" }, { "id": "seo-and-agent-formats", "level": 2, "text": "SEO and agent formats" }, { "id": "design-philosophy", "level": 2, "text": "Design philosophy" }, { "id": "all-workspace-packages", "level": 2, "text": "All workspace packages" } ] }, { "title": "Examples", "description": "", "section": "Documentation", "url": "/packages/sphinx-autodoc-api-style/examples/", "markdownUrl": "/packages/sphinx-autodoc-api-style/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "module-gp_demo_api", "level": 2, "text": "Live demos" }, { "id": "functions", "level": 3, "text": "Functions" }, { "id": "gp_demo_api.demo_function", "level": 4, "text": "demo_function()" }, { "id": "gp_demo_api.demo_async_function", "level": 4, "text": "demo_async_function()" }, { "id": "gp_demo_api.demo_deprecated_function", "level": 4, "text": "demo_deprecated_function()" }, { "id": "module-data", "level": 3, "text": "Module data" }, { "id": "gp_demo_api.DEMO_CONSTANT", "level": 4, "text": "DEMO_CONSTANT" }, { "id": "exceptions", "level": 3, "text": "Exceptions" }, { "id": "gp_demo_api.DemoError", "level": 4, "text": "DemoError" }, { "id": "classes", "level": 3, "text": "Classes" }, { "id": "gp_demo_api.DemoClass", "level": 4, "text": "DemoClass" }, { "id": "gp_demo_api.DemoClass.demo_attr", "level": 5, "text": "demo_attr" }, { "id": "gp_demo_api.DemoClass.__init__", "level": 5, "text": "__init__()" }, { "id": "gp_demo_api.DemoClass.regular_method", "level": 5, "text": "regular_method()" }, { "id": "gp_demo_api.DemoClass.from_int", "level": 5, "text": "from_int()" }, { "id": "gp_demo_api.DemoClass.utility", "level": 5, "text": "utility()" }, { "id": "gp_demo_api.DemoClass.computed", "level": 5, "text": "computed" }, { "id": "gp_demo_api.DemoClass.async_method", "level": 5, "text": "async_method()" }, { "id": "gp_demo_api.DemoClass.deprecated_method", "level": 5, "text": "deprecated_method()" }, { "id": "abstract-base-classes", "level": 3, "text": "Abstract base classes" }, { "id": "gp_demo_api.DemoAbstractBase", "level": 4, "text": "DemoAbstractBase" }, { "id": "gp_demo_api.DemoAbstractBase.must_implement", "level": 5, "text": "must_implement()" }, { "id": "gp_demo_api.DemoAbstractBase.async_abstract", "level": 5, "text": "async_abstract()" } ] }, { "title": "How to", "description": "Type badges (rightmost): function, class, method, property, attribute, data, exception — each with a distinct color", "section": "Documentation", "url": "/packages/sphinx-autodoc-api-style/how-to/", "markdownUrl": "/packages/sphinx-autodoc-api-style/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "features", "level": 2, "text": "Features" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "css-prefix", "level": 2, "text": "CSS prefix" } ] }, { "title": "sphinx-autodoc-api-style", "description": "Alpha GitHub PyPI", "section": "Autodoc", "url": "/packages/sphinx-autodoc-api-style/", "markdownUrl": "/packages/sphinx-autodoc-api-style/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-autodoc-api-style" } ] }, { "title": "API Reference", "description": "All badge classes are drawn from the shared SAB palette. This extension uses:", "section": "Documentation", "url": "/packages/sphinx-autodoc-api-style/reference/", "markdownUrl": "/packages/sphinx-autodoc-api-style/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "badge-reference", "level": 2, "text": "Badge reference" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_autodoc_api_style.setup", "level": 3, "text": "setup()" } ] }, { "title": "Tutorial", "description": "Start with the autodoc directives your API page already uses. Existing sphinx:autofunction, sphinx:autoclass, and sphinx:automodule entries automatically receive badges when the extension is loaded.", "section": "Documentation", "url": "/packages/sphinx-autodoc-api-style/tutorial/", "markdownUrl": "/packages/sphinx-autodoc-api-style/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "add-badges-to-existing-autodoc", "level": 2, "text": "Add badges to existing autodoc" } ] }, { "title": "Examples", "description": "Example CLI showing how sphinx-autodoc-argparse renders parsers.", "section": "Documentation", "url": "/packages/sphinx-autodoc-argparse/examples/", "markdownUrl": "/packages/sphinx-autodoc-argparse/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "live-demos", "level": 2, "text": "Live demos" }, { "id": "base-parser-rendering", "level": 3, "text": "Base parser rendering" }, { "id": "usage", "level": 4, "text": "Usage" }, { "id": "options", "level": 4, "text": "Options" }, { "id": "subcommand-rendering", "level": 3, "text": "Subcommand rendering" }, { "id": "mysubcommand-usage", "level": 4, "text": "Usage" }, { "id": "mysubcommand-options", "level": 4, "text": "Options" }, { "id": "inline-roles", "level": 3, "text": "Inline roles" } ] }, { "title": "How to", "description": "Use this extension when a project needs rendered argparse programs, options, choices, and role links from the same parser object that powers its CLI.", "section": "Documentation", "url": "/packages/sphinx-autodoc-argparse/how-to/", "markdownUrl": "/packages/sphinx-autodoc-argparse/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "find-registered-directives-and-roles", "level": 2, "text": "Find registered directives and roles" }, { "id": "downstream-usage-snippets", "level": 2, "text": "Downstream usage snippets" } ] }, { "title": "sphinx-autodoc-argparse", "description": "Alpha GitHub PyPI", "section": "Autodoc", "url": "/packages/sphinx-autodoc-argparse/", "markdownUrl": "/packages/sphinx-autodoc-argparse/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-autodoc-argparse" } ] }, { "title": "Kitchen sink", "description": "Every directive and role this package registers, exercised once on the same page — useful as a reference card for downstream authors and as a visual-regression target.", "section": "Documentation", "url": "/packages/sphinx-autodoc-argparse/kitchen-sink/", "markdownUrl": "/packages/sphinx-autodoc-argparse/kitchen-sink.md", "headings": [ { "id": "", "level": 1, "text": "Kitchen sink" } ] }, { "title": "API Reference", "description": "Every argparse directive block populates a dedicated argparse domain alongside the existing std:cmdoption entries. Use these roles to link to programs, options, subcommands, and positional argumen...", "section": "Documentation", "url": "/packages/sphinx-autodoc-argparse/reference/", "markdownUrl": "/packages/sphinx-autodoc-argparse/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "cross-reference-roles", "level": 2, "text": "Cross-reference roles" }, { "id": "directive-and-role-reference", "level": 2, "text": "Directive and role reference" }, { "id": "base-argparse-directive", "level": 3, "text": "Base argparse directive" }, { "id": "directive-argparse", "level": 4, "text": ".. argparse::" }, { "id": "directive-option-argparse-func", "level": 5, "text": ":func:" }, { "id": "directive-option-argparse-mock-modules", "level": 5, "text": ":mock-modules:" }, { "id": "directive-option-argparse-module", "level": 5, "text": ":module:" }, { "id": "directive-option-argparse-no-choices", "level": 5, "text": ":no-choices:" }, { "id": "directive-option-argparse-no-defaults", "level": 5, "text": ":no-defaults:" }, { "id": "directive-option-argparse-no-description", "level": 5, "text": ":no-description:" }, { "id": "directive-option-argparse-no-epilog", "level": 5, "text": ":no-epilog:" }, { "id": "directive-option-argparse-no-index", "level": 5, "text": ":no-index:" }, { "id": "directive-option-argparse-no-types", "level": 5, "text": ":no-types:" }, { "id": "directive-option-argparse-nodefault", "level": 5, "text": ":nodefault:" }, { "id": "directive-option-argparse-nodescription", "level": 5, "text": ":nodescription:" }, { "id": "directive-option-argparse-noepilog", "level": 5, "text": ":noepilog:" }, { "id": "directive-option-argparse-nosubcommands", "level": 5, "text": ":nosubcommands:" }, { "id": "directive-option-argparse-path", "level": 5, "text": ":path:" }, { "id": "directive-option-argparse-prog", "level": 5, "text": ":prog:" }, { "id": "exemplar-override", "level": 3, "text": "Exemplar override" }, { "id": "directive-cleanargparse", "level": 4, "text": ".. cleanargparse::" }, { "id": "directive-option-cleanargparse-func", "level": 5, "text": ":func:" }, { "id": "directive-option-cleanargparse-mock-modules", "level": 5, "text": ":mock-modules:" }, { "id": "directive-option-cleanargparse-module", "level": 5, "text": ":module:" }, { "id": "directive-option-cleanargparse-no-choices", "level": 5, "text": ":no-choices:" }, { "id": "directive-option-cleanargparse-no-defaults", "level": 5, "text": ":no-defaults:" }, { "id": "directive-option-cleanargparse-no-description", "level": 5, "text": ":no-description:" }, { "id": "directive-option-cleanargparse-no-epilog", "level": 5, "text": ":no-epilog:" }, { "id": "directive-option-cleanargparse-no-index", "level": 5, "text": ":no-index:" }, { "id": "directive-option-cleanargparse-no-types", "level": 5, "text": ":no-types:" }, { "id": "directive-option-cleanargparse-nodefault", "level": 5, "text": ":nodefault:" }, { "id": "directive-option-cleanargparse-nodescription", "level": 5, "text": ":nodescription:" }, { "id": "directive-option-cleanargparse-noepilog", "level": 5, "text": ":noepilog:" }, { "id": "directive-option-cleanargparse-nosubcommands", "level": 5, "text": ":nosubcommands:" }, { "id": "directive-option-cleanargparse-path", "level": 5, "text": ":path:" }, { "id": "directive-option-cleanargparse-prog", "level": 5, "text": ":prog:" }, { "id": "cli-role-callables", "level": 3, "text": "CLI role callables" }, { "id": "role-cli-choice", "level": 4, "text": ":cli-choice:" }, { "id": "role-cli-command", "level": 4, "text": ":cli-command:" }, { "id": "role-cli-default", "level": 4, "text": ":cli-default:" }, { "id": "role-cli-metavar", "level": 4, "text": ":cli-metavar:" }, { "id": "role-cli-option", "level": 4, "text": ":cli-option:" }, { "id": "auto-generated-indices", "level": 3, "text": "Auto-generated indices" }, { "id": "intersphinx-compatibility", "level": 3, "text": "Intersphinx compatibility" }, { "id": "configuration-values", "level": 2, "text": "Configuration values" }, { "id": "base-extension", "level": 3, "text": "Base extension" }, { "id": "confval-argparse_group_title_prefix", "level": 4, "text": "argparse_group_title_prefix" }, { "id": "confval-argparse_show_defaults", "level": 4, "text": "argparse_show_defaults" }, { "id": "confval-argparse_show_choices", "level": 4, "text": "argparse_show_choices" }, { "id": "confval-argparse_show_types", "level": 4, "text": "argparse_show_types" }, { "id": "exemplar-layer", "level": 3, "text": "Exemplar layer" }, { "id": "confval-argparse_examples_term_suffix", "level": 4, "text": "argparse_examples_term_suffix" }, { "id": "confval-argparse_examples_base_term", "level": 4, "text": "argparse_examples_base_term" }, { "id": "confval-argparse_examples_section_title", "level": 4, "text": "argparse_examples_section_title" }, { "id": "confval-argparse_usage_pattern", "level": 4, "text": "argparse_usage_pattern" }, { "id": "confval-argparse_examples_command_prefix", "level": 4, "text": "argparse_examples_command_prefix" }, { "id": "confval-argparse_examples_code_language", "level": 4, "text": "argparse_examples_code_language" }, { "id": "confval-argparse_examples_code_classes", "level": 4, "text": "argparse_examples_code_classes" }, { "id": "confval-argparse_usage_code_language", "level": 4, "text": "argparse_usage_code_language" }, { "id": "confval-argparse_reorder_usage_before_examples", "level": 4, "text": "argparse_reorder_usage_before_examples" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_autodoc_argparse.setup", "level": 3, "text": "setup()" } ] }, { "title": "Tutorial", "description": "Start by loading the base parser extension and the exemplar layer. The exemplar layer gives you the cleaner directive and roles used across the gp-sphinx docs:", "section": "Documentation", "url": "/packages/sphinx-autodoc-argparse/tutorial/", "markdownUrl": "/packages/sphinx-autodoc-argparse/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "document-your-first-parser", "level": 2, "text": "Document your first parser" } ] }, { "title": "Examples", "description": "This page intentionally uses directive and role autodoc to document the documentation helpers themselves. If that feels a little recursive, that is the point: roles and directives should be documen...", "section": "Documentation", "url": "/packages/sphinx-autodoc-docutils/examples/", "markdownUrl": "/packages/sphinx-autodoc-docutils/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "live-demos", "level": 2, "text": "Live demos" }, { "id": "document-one-demo-directive", "level": 3, "text": "Document one demo directive" }, { "id": "document-one-demo-role", "level": 3, "text": "Document one demo role" }, { "id": "bulk-directives-demo", "level": 3, "text": "Bulk directives demo" }, { "id": "bulk-roles-demo", "level": 3, "text": "Bulk roles demo" }, { "id": "document-one-demo-transform", "level": 3, "text": "Document one demo transform" }, { "id": "docutils-transform-docutils_demo_components.DemoReorderTransform", "level": 4, "text": "DemoReorderTransform" }, { "id": "bulk-transforms-demo", "level": 3, "text": "Bulk transforms demo" }, { "id": "document-one-demo-reader", "level": 3, "text": "Document one demo reader" }, { "id": "docutils-reader-docutils_demo_components.DemoArticleReader", "level": 4, "text": "DemoArticleReader" }, { "id": "bulk-readers-demo", "level": 3, "text": "Bulk readers demo" }, { "id": "document-one-demo-parser", "level": 3, "text": "Document one demo parser" }, { "id": "docutils-parser-docutils_demo_components.DemoLineParser", "level": 4, "text": "DemoLineParser" }, { "id": "bulk-parsers-demo", "level": 3, "text": "Bulk parsers demo" }, { "id": "document-one-demo-writer", "level": 3, "text": "Document one demo writer" }, { "id": "docutils-writer-docutils_demo_components.DemoPlainWriter", "level": 4, "text": "DemoPlainWriter" }, { "id": "bulk-writers-demo", "level": 3, "text": "Bulk writers demo" }, { "id": "document-one-demo-node", "level": 3, "text": "Document one demo node" }, { "id": "docutils-node-docutils_demo_components.demo_marker", "level": 4, "text": "demo_marker" }, { "id": "bulk-nodes-demo", "level": 3, "text": "Bulk nodes demo" }, { "id": "document-one-demo-translator", "level": 3, "text": "Document one demo translator" }, { "id": "docutils-translator-docutils_demo_components.DemoTextTranslator", "level": 4, "text": "DemoTextTranslator" }, { "id": "bulk-translators-demo", "level": 3, "text": "Bulk translators demo" }, { "id": "cross-referencing-components", "level": 3, "text": "Cross-referencing components" }, { "id": "demo-module-reference", "level": 2, "text": "Demo module reference" }, { "id": "docutils_demo.DemoBadgeDirective", "level": 3, "text": "DemoBadgeDirective" }, { "id": "docutils_demo.DemoBadgeDirective.required_arguments", "level": 4, "text": "required_arguments" }, { "id": "docutils_demo.DemoBadgeDirective.optional_arguments", "level": 4, "text": "optional_arguments" }, { "id": "docutils_demo.DemoBadgeDirective.final_argument_whitespace", "level": 4, "text": "final_argument_whitespace" }, { "id": "docutils_demo.DemoBadgeDirective.has_content", "level": 4, "text": "has_content" }, { "id": "docutils_demo.DemoBadgeDirective.option_spec", "level": 4, "text": "option_spec" }, { "id": "docutils_demo.DemoBadgeDirective.run", "level": 4, "text": "run()" }, { "id": "docutils_demo.DemoCalloutDirective", "level": 3, "text": "DemoCalloutDirective" }, { "id": "docutils_demo.DemoCalloutDirective.required_arguments", "level": 4, "text": "required_arguments" }, { "id": "docutils_demo.DemoCalloutDirective.optional_arguments", "level": 4, "text": "optional_arguments" }, { "id": "docutils_demo.DemoCalloutDirective.has_content", "level": 4, "text": "has_content" }, { "id": "docutils_demo.DemoCalloutDirective.option_spec", "level": 4, "text": "option_spec" }, { "id": "docutils_demo.DemoCalloutDirective.run", "level": 4, "text": "run()" }, { "id": "docutils_demo.demo_badge_role", "level": 3, "text": "demo_badge_role()" }, { "id": "docutils_demo_components.DemoReorderTransform", "level": 3, "text": "DemoReorderTransform" }, { "id": "docutils_demo_components.DemoReorderTransform.default_priority", "level": 4, "text": "default_priority" }, { "id": "docutils_demo_components.DemoReorderTransform.apply", "level": 4, "text": "apply()" }, { "id": "docutils_demo_components.DemoArticleReader", "level": 3, "text": "DemoArticleReader" }, { "id": "docutils_demo_components.DemoArticleReader.supported", "level": 4, "text": "supported" }, { "id": "docutils_demo_components.DemoArticleReader.config_section", "level": 4, "text": "config_section" }, { "id": "docutils_demo_components.DemoArticleReader.get_transforms", "level": 4, "text": "get_transforms()" }, { "id": "docutils_demo_components.DemoLineParser", "level": 3, "text": "DemoLineParser" }, { "id": "docutils_demo_components.DemoLineParser.supported", "level": 4, "text": "supported" }, { "id": "docutils_demo_components.DemoLineParser.config_section", "level": 4, "text": "config_section" }, { "id": "docutils_demo_components.DemoLineParser.parse", "level": 4, "text": "parse()" }, { "id": "docutils_demo_components.demo_marker", "level": 3, "text": "demo_marker" }, { "id": "docutils_demo_components.visit_demo_marker", "level": 3, "text": "visit_demo_marker()" }, { "id": "docutils_demo_components.depart_demo_marker", "level": 3, "text": "depart_demo_marker()" }, { "id": "docutils_demo_components.DemoTextTranslator", "level": 3, "text": "DemoTextTranslator" }, { "id": "docutils_demo_components.DemoTextTranslator.__init__", "level": 4, "text": "__init__()" }, { "id": "docutils_demo_components.DemoTextTranslator.visit_paragraph", "level": 4, "text": "visit_paragraph()" }, { "id": "docutils_demo_components.DemoTextTranslator.depart_paragraph", "level": 4, "text": "depart_paragraph()" }, { "id": "docutils_demo_components.DemoTextTranslator.visit_Text", "level": 4, "text": "visit_Text()" }, { "id": "docutils_demo_components.DemoTextTranslator.unknown_visit", "level": 4, "text": "unknown_visit()" }, { "id": "docutils_demo_components.DemoTextTranslator.unknown_departure", "level": 4, "text": "unknown_departure()" }, { "id": "docutils_demo_components.DemoPlainWriter", "level": 3, "text": "DemoPlainWriter" }, { "id": "docutils_demo_components.DemoPlainWriter.supported", "level": 4, "text": "supported" }, { "id": "docutils_demo_components.DemoPlainWriter.config_section", "level": 4, "text": "config_section" }, { "id": "docutils_demo_components.DemoPlainWriter.__init__", "level": 4, "text": "__init__()" }, { "id": "docutils_demo_components.DemoPlainWriter.translate", "level": 4, "text": "translate()" }, { "id": "docutils_demo_components.setup", "level": 3, "text": "setup()" } ] }, { "title": "How to", "description": "Use this extension when your docs extension exposes docutils directives, roles, nodes, readers, parsers, writers, translators, or transforms that deserve generated reference pages and cross-referen...", "section": "Documentation", "url": "/packages/sphinx-autodoc-docutils/how-to/", "markdownUrl": "/packages/sphinx-autodoc-docutils/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "cross-reference-documented-components", "level": 2, "text": "Cross-reference documented components" } ] }, { "title": "sphinx-autodoc-docutils", "description": "Alpha GitHub PyPI", "section": "Autodoc", "url": "/packages/sphinx-autodoc-docutils/", "markdownUrl": "/packages/sphinx-autodoc-docutils/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-autodoc-docutils" } ] }, { "title": "Kitchen sink", "description": "Every directive and role this package registers, exercised once on the same page — useful as a reference card for downstream authors and as a visual-regression target.", "section": "Documentation", "url": "/packages/sphinx-autodoc-docutils/kitchen-sink/", "markdownUrl": "/packages/sphinx-autodoc-docutils/kitchen-sink.md", "headings": [ { "id": "", "level": 1, "text": "Kitchen sink" } ] }, { "title": "API Reference", "description": "Generated from add_directive() registrations in sphinx_autodoc_docutils/__init__.py via the package’s own bulk directive — every auto* pair documents itself.", "section": "Documentation", "url": "/packages/sphinx-autodoc-docutils/reference/", "markdownUrl": "/packages/sphinx-autodoc-docutils/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "directive-reference", "level": 2, "text": "Directive reference" }, { "id": "directive-autodirective", "level": 3, "text": ".. autodirective::" }, { "id": "directive-option-autodirective-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autodirectives", "level": 3, "text": ".. autodirectives::" }, { "id": "directive-option-autodirectives-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autorole", "level": 3, "text": ".. autorole::" }, { "id": "directive-option-autorole-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autoroles", "level": 3, "text": ".. autoroles::" }, { "id": "directive-option-autoroles-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autotransform", "level": 3, "text": ".. autotransform::" }, { "id": "directive-option-autotransform-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autotransforms", "level": 3, "text": ".. autotransforms::" }, { "id": "directive-option-autotransforms-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autoreader", "level": 3, "text": ".. autoreader::" }, { "id": "directive-option-autoreader-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autoreaders", "level": 3, "text": ".. autoreaders::" }, { "id": "directive-option-autoreaders-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autoparser", "level": 3, "text": ".. autoparser::" }, { "id": "directive-option-autoparser-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autoparsers", "level": 3, "text": ".. autoparsers::" }, { "id": "directive-option-autoparsers-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autowriter", "level": 3, "text": ".. autowriter::" }, { "id": "directive-option-autowriter-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autowriters", "level": 3, "text": ".. autowriters::" }, { "id": "directive-option-autowriters-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autonode", "level": 3, "text": ".. autonode::" }, { "id": "directive-option-autonode-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autonodes", "level": 3, "text": ".. autonodes::" }, { "id": "directive-option-autonodes-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autotranslator", "level": 3, "text": ".. autotranslator::" }, { "id": "directive-option-autotranslator-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autotranslators", "level": 3, "text": ".. autotranslators::" }, { "id": "directive-option-autotranslators-no-index", "level": 4, "text": ":no-index:" }, { "id": "cross-reference-roles", "level": 2, "text": "Cross-reference roles" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_autodoc_docutils.setup", "level": 3, "text": "setup()" } ] }, { "title": "Tutorial", "description": "Use a single-object directive when you want one rendered reference entry:", "section": "Documentation", "url": "/packages/sphinx-autodoc-docutils/tutorial/", "markdownUrl": "/packages/sphinx-autodoc-docutils/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "document-your-first-directive-or-role", "level": 2, "text": "Document your first directive or role" } ] }, { "title": "Examples", "description": "Use for a linked badge, or for a plain inline reference.", "section": "Documentation", "url": "/packages/sphinx-autodoc-fastmcp/examples/", "markdownUrl": "/packages/sphinx-autodoc-fastmcp/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "live-demos", "level": 2, "text": "Live demos" }, { "id": "tool-cards", "level": 3, "text": "Tool cards" }, { "id": "fastmcp-tool-list-sessions", "level": 4, "text": "list_sessions" }, { "id": "fastmcp-tool-create-session", "level": 4, "text": "create_session" }, { "id": "fastmcp-tool-delete-session", "level": 4, "text": "delete_session" }, { "id": "parameter-table", "level": 3, "text": "Parameter table" }, { "id": "tool-summary", "level": 3, "text": "Tool summary" }, { "id": "inspect", "level": 4, "text": "Inspect" }, { "id": "act", "level": 4, "text": "Act" }, { "id": "destroy", "level": 4, "text": "Destroy" }, { "id": "demo-module-reference", "level": 2, "text": "Demo module reference" }, { "id": "fastmcp_demo_tools.list_sessions", "level": 3, "text": "list_sessions()" }, { "id": "fastmcp_demo_tools.create_session", "level": 3, "text": "create_session()" }, { "id": "fastmcp_demo_tools.delete_session", "level": 3, "text": "delete_session()" } ] }, { "title": "How to", "description": "Use this extension when a FastMCP server should document its tools, resources, prompts, generated schemas, safety metadata, and cross-reference badges from live registration data.", "section": "Documentation", "url": "/packages/sphinx-autodoc-fastmcp/how-to/", "markdownUrl": "/packages/sphinx-autodoc-fastmcp/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "live-server-collection", "level": 2, "text": "Live server collection" } ] }, { "title": "sphinx-autodoc-fastmcp", "description": "Alpha GitHub PyPI", "section": "Autodoc", "url": "/packages/sphinx-autodoc-fastmcp/", "markdownUrl": "/packages/sphinx-autodoc-fastmcp/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-autodoc-fastmcp" } ] }, { "title": "Kitchen sink", "description": "Every directive and role this package registers, exercised once on the same page — useful as a reference card for downstream authors and as a visual-regression target.", "section": "Documentation", "url": "/packages/sphinx-autodoc-fastmcp/kitchen-sink/", "markdownUrl": "/packages/sphinx-autodoc-fastmcp/kitchen-sink.md", "headings": [ { "id": "", "level": 1, "text": "Kitchen sink" } ] }, { "title": "API Reference", "description": "Generated from add_config_value() registrations in sphinx_autodoc_fastmcp/__init__.py.", "section": "Documentation", "url": "/packages/sphinx-autodoc-fastmcp/reference/", "markdownUrl": "/packages/sphinx-autodoc-fastmcp/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-fastmcp_tool_modules", "level": 3, "text": "fastmcp_tool_modules" }, { "id": "confval-fastmcp_area_map", "level": 3, "text": "fastmcp_area_map" }, { "id": "confval-fastmcp_model_module", "level": 3, "text": "fastmcp_model_module" }, { "id": "confval-fastmcp_model_classes", "level": 3, "text": "fastmcp_model_classes" }, { "id": "confval-fastmcp_section_badge_map", "level": 3, "text": "fastmcp_section_badge_map" }, { "id": "confval-fastmcp_section_badge_pages", "level": 3, "text": "fastmcp_section_badge_pages" }, { "id": "confval-fastmcp_collector_mode", "level": 3, "text": "fastmcp_collector_mode" }, { "id": "confval-fastmcp_server_module", "level": 3, "text": "fastmcp_server_module" }, { "id": "directive-and-role-reference", "level": 2, "text": "Directive and role reference" }, { "id": "directive-fastmcp-tool", "level": 3, "text": ".. fastmcp-tool::" }, { "id": "directive-option-fastmcp-tool-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-fastmcp-tool-input", "level": 3, "text": ".. fastmcp-tool-input::" }, { "id": "directive-fastmcp-tool-summary", "level": 3, "text": ".. fastmcp-tool-summary::" }, { "id": "directive-fastmcp-prompt", "level": 3, "text": ".. fastmcp-prompt::" }, { "id": "directive-option-fastmcp-prompt-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-fastmcp-prompt-input", "level": 3, "text": ".. fastmcp-prompt-input::" }, { "id": "directive-fastmcp-resource", "level": 3, "text": ".. fastmcp-resource::" }, { "id": "directive-option-fastmcp-resource-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-fastmcp-resource-template", "level": 3, "text": ".. fastmcp-resource-template::" }, { "id": "directive-option-fastmcp-resource-template-no-index", "level": 4, "text": ":no-index:" }, { "id": "role-tool", "level": 3, "text": ":tool:" }, { "id": "role-toolref", "level": 3, "text": ":toolref:" }, { "id": "role-toolicon", "level": 3, "text": ":toolicon:" }, { "id": "role-tooliconl", "level": 3, "text": ":tooliconl:" }, { "id": "role-tooliconr", "level": 3, "text": ":tooliconr:" }, { "id": "role-tooliconil", "level": 3, "text": ":tooliconil:" }, { "id": "role-tooliconir", "level": 3, "text": ":tooliconir:" }, { "id": "role-resource", "level": 3, "text": ":resource:" }, { "id": "role-resourceref", "level": 3, "text": ":resourceref:" }, { "id": "role-prompt", "level": 3, "text": ":prompt:" }, { "id": "role-promptref", "level": 3, "text": ":promptref:" }, { "id": "role-badge", "level": 3, "text": ":badge:" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_autodoc_fastmcp.setup", "level": 3, "text": "setup()" } ] }, { "title": "Tutorial", "description": "Render one tool card:", "section": "Documentation", "url": "/packages/sphinx-autodoc-fastmcp/tutorial/", "markdownUrl": "/packages/sphinx-autodoc-fastmcp/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "document-your-first-tool", "level": 2, "text": "Document your first tool" }, { "id": "prompts-and-resources", "level": 3, "text": "Prompts and resources" }, { "id": "ref-cross-reference-ids", "level": 3, "text": ":ref: cross-reference IDs" } ] }, { "title": "Examples", "description": "Add project-specific usage notes here. The helper renders the install section, autodiscovery note, and full fixture summary/reference.", "section": "Documentation", "url": "/packages/sphinx-autodoc-pytest-fixtures/examples/", "markdownUrl": "/packages/sphinx-autodoc-pytest-fixtures/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "module-spf_demo_fixtures", "level": 2, "text": "Live demos" }, { "id": "bulk-autodoc", "level": 3, "text": "Bulk autodoc" }, { "id": "plugin-page-helper", "level": 3, "text": "Plugin page helper" }, { "id": "spf_demo_fixtures.demo_plain", "level": 4, "text": "demo_plain" }, { "id": "spf_demo_fixtures.demo_session", "level": 4, "text": "demo_session" }, { "id": "spf_demo_fixtures.demo_module", "level": 4, "text": "demo_module" }, { "id": "spf_demo_fixtures.demo_class", "level": 4, "text": "demo_class" }, { "id": "spf_demo_fixtures.demo_factory", "level": 4, "text": "demo_factory" }, { "id": "spf_demo_fixtures.demo_override_hook", "level": 4, "text": "demo_override_hook" }, { "id": "spf_demo_fixtures.demo_autouse", "level": 4, "text": "demo_autouse" }, { "id": "spf_demo_fixtures.demo_deprecated", "level": 4, "text": "demo_deprecated" }, { "id": "spf_demo_fixtures.demo_session_factory", "level": 4, "text": "demo_session_factory" }, { "id": "spf_demo_fixtures.demo_session_autouse", "level": 4, "text": "demo_session_autouse" }, { "id": "plugin-page-helper-usage", "level": 4, "text": "Plugin page helper usage" }, { "id": "bulk-fixture-options", "level": 4, "text": "Bulk fixture options" }, { "id": "single-autodoc-entries", "level": 3, "text": "Single autodoc entries" }, { "id": "manual-domain-directive", "level": 3, "text": "Manual domain directive" } ] }, { "title": "How to", "description": "Use this extension when a pytest plugin needs fixture reference pages with scope badges, linting for missing docs, and optional links back to external fixture documentation.", "section": "Documentation", "url": "/packages/sphinx-autodoc-pytest-fixtures/how-to/", "markdownUrl": "/packages/sphinx-autodoc-pytest-fixtures/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "find-configuration-values", "level": 2, "text": "Find configuration values" } ] }, { "title": "sphinx-autodoc-pytest-fixtures", "description": "Alpha GitHub PyPI", "section": "Autodoc", "url": "/packages/sphinx-autodoc-pytest-fixtures/", "markdownUrl": "/packages/sphinx-autodoc-pytest-fixtures/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-autodoc-pytest-fixtures" } ] }, { "title": "Kitchen sink", "description": "Every directive and role this package registers, exercised once on the same page — useful as a reference card for downstream authors and as a visual-regression target.", "section": "Documentation", "url": "/packages/sphinx-autodoc-pytest-fixtures/kitchen-sink/", "markdownUrl": "/packages/sphinx-autodoc-pytest-fixtures/kitchen-sink.md", "headings": [ { "id": "", "level": 1, "text": "Kitchen sink" } ] }, { "title": "API Reference", "description": "Generated from add_directive() registrations in sphinx_autodoc_pytest_fixtures/__init__.py via /packages/sphinx-autodoc-docutils/index.", "section": "Documentation", "url": "/packages/sphinx-autodoc-pytest-fixtures/reference/", "markdownUrl": "/packages/sphinx-autodoc-pytest-fixtures/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "directive-reference", "level": 2, "text": "Directive reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-pytest_fixture_hidden_dependencies", "level": 3, "text": "pytest_fixture_hidden_dependencies" }, { "id": "confval-pytest_fixture_builtin_links", "level": 3, "text": "pytest_fixture_builtin_links" }, { "id": "confval-pytest_fixture_external_links", "level": 3, "text": "pytest_fixture_external_links" }, { "id": "confval-pytest_fixture_lint_level", "level": 3, "text": "pytest_fixture_lint_level" }, { "id": "directive-fixture", "level": 3, "text": ".. fixture::" }, { "id": "directive-option-fixture-annotation", "level": 4, "text": ":annotation:" }, { "id": "directive-option-fixture-async", "level": 4, "text": ":async:" }, { "id": "directive-option-fixture-autouse", "level": 4, "text": ":autouse:" }, { "id": "directive-option-fixture-canonical", "level": 4, "text": ":canonical:" }, { "id": "directive-option-fixture-depends", "level": 4, "text": ":depends:" }, { "id": "directive-option-fixture-deprecated", "level": 4, "text": ":deprecated:" }, { "id": "directive-option-fixture-factory", "level": 4, "text": ":factory:" }, { "id": "directive-option-fixture-kind", "level": 4, "text": ":kind:" }, { "id": "directive-option-fixture-module", "level": 4, "text": ":module:" }, { "id": "directive-option-fixture-no-contents-entry", "level": 4, "text": ":no-contents-entry:" }, { "id": "directive-option-fixture-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-option-fixture-no-index-entry", "level": 4, "text": ":no-index-entry:" }, { "id": "directive-option-fixture-no-typesetting", "level": 4, "text": ":no-typesetting:" }, { "id": "directive-option-fixture-nocontentsentry", "level": 4, "text": ":nocontentsentry:" }, { "id": "directive-option-fixture-noindex", "level": 4, "text": ":noindex:" }, { "id": "directive-option-fixture-noindexentry", "level": 4, "text": ":noindexentry:" }, { "id": "directive-option-fixture-overridable", "level": 4, "text": ":overridable:" }, { "id": "directive-option-fixture-params", "level": 4, "text": ":params:" }, { "id": "directive-option-fixture-replacement", "level": 4, "text": ":replacement:" }, { "id": "directive-option-fixture-return-type", "level": 4, "text": ":return-type:" }, { "id": "directive-option-fixture-scope", "level": 4, "text": ":scope:" }, { "id": "directive-option-fixture-single-line-parameter-list", "level": 4, "text": ":single-line-parameter-list:" }, { "id": "directive-option-fixture-single-line-type-parameter-list", "level": 4, "text": ":single-line-type-parameter-list:" }, { "id": "directive-option-fixture-teardown", "level": 4, "text": ":teardown:" }, { "id": "directive-option-fixture-teardown-summary", "level": 4, "text": ":teardown-summary:" }, { "id": "directive-option-fixture-usage", "level": 4, "text": ":usage:" }, { "id": "directive-autofixtures", "level": 3, "text": ".. autofixtures::" }, { "id": "directive-option-autofixtures-exclude", "level": 4, "text": ":exclude:" }, { "id": "directive-option-autofixtures-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-option-autofixtures-order", "level": 4, "text": ":order:" }, { "id": "directive-auto-pytest-plugin", "level": 3, "text": ".. auto-pytest-plugin::" }, { "id": "directive-option-auto-pytest-plugin-install-command", "level": 4, "text": ":install-command:" }, { "id": "directive-option-auto-pytest-plugin-package", "level": 4, "text": ":package:" }, { "id": "directive-option-auto-pytest-plugin-project", "level": 4, "text": ":project:" }, { "id": "directive-option-auto-pytest-plugin-summary", "level": 4, "text": ":summary:" }, { "id": "directive-option-auto-pytest-plugin-tests-url", "level": 4, "text": ":tests-url:" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_autodoc_pytest_fixtures.setup", "level": 3, "text": "setup()" } ] }, { "title": "Tutorial", "description": "Render a standard pytest plugin page:", "section": "Documentation", "url": "/packages/sphinx-autodoc-pytest-fixtures/tutorial/", "markdownUrl": "/packages/sphinx-autodoc-pytest-fixtures/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "document-a-plugin-page", "level": 2, "text": "Document a plugin page" } ] }, { "title": "Examples", "description": "This page also uses sphinx-autodoc-docutils to document the config-doc directives themselves, so the page demonstrates both config-value output and directive documentation.", "section": "Documentation", "url": "/packages/sphinx-autodoc-sphinx/examples/", "markdownUrl": "/packages/sphinx-autodoc-sphinx/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "live-demos", "level": 2, "text": "Live demos" }, { "id": "render-a-single-demo-config-value", "level": 3, "text": "Render a single demo config value" }, { "id": "bulk-config-values-demo", "level": 3, "text": "Bulk config values demo" }, { "id": "confval-demo_theme_accent", "level": 4, "text": "demo_theme_accent" }, { "id": "confval-demo_show_callouts", "level": 4, "text": "demo_show_callouts" }, { "id": "document-one-demo-builder", "level": 3, "text": "Document one demo builder" }, { "id": "sphinxext-builder-sphinx_demo_builder.DemoArchiveBuilder", "level": 4, "text": "DemoArchiveBuilder" }, { "id": "bulk-builders-demo", "level": 3, "text": "Bulk builders demo" }, { "id": "document-one-demo-domain", "level": 3, "text": "Document one demo domain" }, { "id": "sphinxext-domain-sphinx_demo_builder.DemoTopicDomain", "level": 4, "text": "DemoTopicDomain" }, { "id": "bulk-domains-demo", "level": 3, "text": "Bulk domains demo" }, { "id": "cross-referencing-components", "level": 3, "text": "Cross-referencing components" }, { "id": "demo-module-reference", "level": 2, "text": "Demo module reference" }, { "id": "sphinx_config_demo.setup", "level": 3, "text": "setup()" }, { "id": "sphinx_config_single_demo.setup", "level": 3, "text": "setup()" }, { "id": "sphinx_demo_builder.DemoArchiveBuilder", "level": 3, "text": "DemoArchiveBuilder" }, { "id": "sphinx_demo_builder.DemoArchiveBuilder.name", "level": 4, "text": "name" }, { "id": "sphinx_demo_builder.DemoArchiveBuilder.format", "level": 4, "text": "format" }, { "id": "sphinx_demo_builder.DemoArchiveBuilder.epilog", "level": 4, "text": "epilog" }, { "id": "sphinx_demo_builder.DemoArchiveBuilder.supported_image_types", "level": 4, "text": "supported_image_types" }, { "id": "sphinx_demo_builder.DemoArchiveBuilder.get_outdated_docs", "level": 4, "text": "get_outdated_docs()" }, { "id": "sphinx_demo_builder.DemoArchiveBuilder.get_target_uri", "level": 4, "text": "get_target_uri()" }, { "id": "sphinx_demo_builder.DemoArchiveBuilder.prepare_writing", "level": 4, "text": "prepare_writing()" }, { "id": "sphinx_demo_builder.DemoArchiveBuilder.write_doc", "level": 4, "text": "write_doc()" }, { "id": "sphinx_demo_builder.DemoTopicDomain", "level": 3, "text": "DemoTopicDomain" }, { "id": "sphinx_demo_builder.DemoTopicDomain.name", "level": 4, "text": "name" }, { "id": "sphinx_demo_builder.DemoTopicDomain.label", "level": 4, "text": "label" }, { "id": "sphinx_demo_builder.DemoTopicDomain.object_types", "level": 4, "text": "object_types" }, { "id": "sphinx_demo_builder.DemoTopicDomain.roles", "level": 4, "text": "roles" }, { "id": "sphinx_demo_builder.setup", "level": 3, "text": "setup()" } ] }, { "title": "How to", "description": "Use this extension when a Sphinx extension needs generated reference pages for builders, domains, and configuration values that readers can link from prose.", "section": "Documentation", "url": "/packages/sphinx-autodoc-sphinx/how-to/", "markdownUrl": "/packages/sphinx-autodoc-sphinx/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "cross-reference-documented-components", "level": 2, "text": "Cross-reference documented components" } ] }, { "title": "sphinx-autodoc-sphinx", "description": "Alpha GitHub PyPI", "section": "Autodoc", "url": "/packages/sphinx-autodoc-sphinx/", "markdownUrl": "/packages/sphinx-autodoc-sphinx/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-autodoc-sphinx" } ] }, { "title": "Kitchen sink", "description": "Every directive and role this package registers, exercised once on the same page — useful as a reference card for downstream authors and as a visual-regression target.", "section": "Documentation", "url": "/packages/sphinx-autodoc-sphinx/kitchen-sink/", "markdownUrl": "/packages/sphinx-autodoc-sphinx/kitchen-sink.md", "headings": [ { "id": "", "level": 1, "text": "Kitchen sink" } ] }, { "title": "API Reference", "description": "Generated from add_directive() registrations in sphinx_autodoc_sphinx/__init__.py via /packages/sphinx-autodoc-docutils/index — a meta-loop where the package that documents config values uses its s...", "section": "Documentation", "url": "/packages/sphinx-autodoc-sphinx/reference/", "markdownUrl": "/packages/sphinx-autodoc-sphinx/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "directive-reference", "level": 2, "text": "Directive reference" }, { "id": "directive-autoconfigvalue", "level": 3, "text": ".. autoconfigvalue::" }, { "id": "directive-option-autoconfigvalue-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autoconfigvalues", "level": 3, "text": ".. autoconfigvalues::" }, { "id": "directive-option-autoconfigvalues-exclude", "level": 4, "text": ":exclude:" }, { "id": "directive-option-autoconfigvalues-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autobuilder", "level": 3, "text": ".. autobuilder::" }, { "id": "directive-option-autobuilder-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autobuilders", "level": 3, "text": ".. autobuilders::" }, { "id": "directive-option-autobuilders-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autodomain", "level": 3, "text": ".. autodomain::" }, { "id": "directive-option-autodomain-no-index", "level": 4, "text": ":no-index:" }, { "id": "directive-autodomains", "level": 3, "text": ".. autodomains::" }, { "id": "directive-option-autodomains-no-index", "level": 4, "text": ":no-index:" }, { "id": "cross-reference-roles", "level": 2, "text": "Cross-reference roles" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_autodoc_sphinx.setup", "level": 3, "text": "setup()" } ] }, { "title": "Tutorial", "description": "Render one config value:", "section": "Documentation", "url": "/packages/sphinx-autodoc-sphinx/tutorial/", "markdownUrl": "/packages/sphinx-autodoc-sphinx/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "document-a-sphinx-extension-surface", "level": 2, "text": "Document a Sphinx extension surface" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a sphinx-autodoc-typehints-gp dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/sphinx-autodoc-typehints-gp/dependents/", "markdownUrl": "/packages/sphinx-autodoc-typehints-gp/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "Examples", "description": "The demos below exercise every rendering improvement sphinx-autodoc-typehints-gp ships beyond stock Sphinx + autodoc. Each section opens with a one-line “what’s interesting here”, then shows the re...", "section": "Documentation", "url": "/packages/sphinx-autodoc-typehints-gp/examples/", "markdownUrl": "/packages/sphinx-autodoc-typehints-gp/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "source-text-parameter-defaults", "level": 2, "text": "Source-text parameter defaults" }, { "id": "dataclass-field-default-factory-rendering", "level": 2, "text": "Dataclass field(default_factory=…) rendering" }, { "id": "api_demo_typehints_gp.HookCounters", "level": 3, "text": "HookCounters" }, { "id": "api_demo_typehints_gp.HookCounters.alerts", "level": 4, "text": "alerts" }, { "id": "api_demo_typehints_gp.HookCounters.index", "level": 4, "text": "index" }, { "id": "api_demo_typehints_gp.HookCounters.names", "level": 4, "text": "names" }, { "id": "api_demo_typehints_gp.HookCounters.tags", "level": 4, "text": "tags" }, { "id": "api_demo_typehints_gp.HookCounters.__init__", "level": 4, "text": "__init__()" }, { "id": "api_demo_typehints_gp.HookCounters.transports", "level": 4, "text": "transports" }, { "id": "long-module-level-constants", "level": 2, "text": "Long module-level constants" }, { "id": "api_demo_typehints_gp.SHORT_DEFAULT", "level": 3, "text": "SHORT_DEFAULT" }, { "id": "api_demo_typehints_gp.LONG_DEFAULT_RULES", "level": 3, "text": "LONG_DEFAULT_RULES" }, { "id": "cross-referenced-default-values", "level": 2, "text": "Cross-referenced default values" }, { "id": "api_demo_typehints_gp.open_session", "level": 3, "text": "open_session()" }, { "id": "api_demo_typehints_gp.with_lambda_default", "level": 3, "text": "with_lambda_default()" }, { "id": "field-list-xref-styling", "level": 2, "text": "Field-list xref styling" }, { "id": "documented-targets-used-by-the-demos", "level": 2, "text": "Documented targets used by the demos" }, { "id": "api_demo_typehints_gp.CacheScope", "level": 3, "text": "CacheScope" }, { "id": "api_demo_typehints_gp.CacheScope.Process", "level": 4, "text": "Process" }, { "id": "api_demo_typehints_gp.CacheScope.Session", "level": 4, "text": "Session" }, { "id": "api_demo_typehints_gp.CacheScope.Global", "level": 4, "text": "Global" }, { "id": "api_demo_typehints_gp.Transport", "level": 3, "text": "Transport" }, { "id": "api_demo_typehints_gp.ConnectionFailure", "level": 3, "text": "ConnectionFailure" }, { "id": "api_demo_typehints_gp.DEFAULT_RETRY", "level": 3, "text": "DEFAULT_RETRY" } ] }, { "title": "How to", "description": "Use this extension when autodoc output needs static annotation rendering, NumPy-style field-list cross-references, and reusable type-display helpers without importing application-only dependencies.", "section": "Documentation", "url": "/packages/sphinx-autodoc-typehints-gp/how-to/", "markdownUrl": "/packages/sphinx-autodoc-typehints-gp/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "installation", "level": 2, "text": "Installation" }, { "id": "pipeline-position", "level": 2, "text": "Pipeline position" }, { "id": "features", "level": 2, "text": "Features" }, { "id": "describing-class-level-names", "level": 2, "text": "Describing class-level names" }, { "id": "what-happens-to-a-name-you-describe-nowhere", "level": 3, "text": "What happens to a name you describe nowhere" }, { "id": "hiding-incidental-doctest-setup", "level": 2, "text": "Hiding incidental doctest setup" }, { "id": "shared-layer", "level": 2, "text": "Shared layer" }, { "id": "choosing-the-right-helper", "level": 2, "text": "Choosing the right helper" }, { "id": "annotation-display-classification", "level": 2, "text": "Annotation display classification" }, { "id": "static-resolution", "level": 2, "text": "Static resolution" } ] }, { "title": "sphinx-autodoc-typehints-gp", "description": "Alpha GitHub PyPI", "section": "Autodoc", "url": "/packages/sphinx-autodoc-typehints-gp/", "markdownUrl": "/packages/sphinx-autodoc-typehints-gp/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-autodoc-typehints-gp" } ] }, { "title": "API Reference", "description": "Generated from add_config_value() registrations in sphinx_autodoc_typehints_gp/extension.py.", "section": "Documentation", "url": "/packages/sphinx-autodoc-typehints-gp/reference/", "markdownUrl": "/packages/sphinx-autodoc-typehints-gp/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-gp_typehints_curate_param_defaults", "level": 3, "text": "gp_typehints_curate_param_defaults" }, { "id": "confval-gp_typehints_curate_data_defaults", "level": 3, "text": "gp_typehints_curate_data_defaults" }, { "id": "confval-gp_typehints_show_undocumented_class_vars", "level": 3, "text": "gp_typehints_show_undocumented_class_vars" }, { "id": "annotation-rendering", "level": 2, "text": "Annotation rendering" }, { "id": "sphinx_autodoc_typehints_gp.build_annotation_paragraph", "level": 3, "text": "build_annotation_paragraph()" }, { "id": "sphinx_autodoc_typehints_gp.build_annotation_display_paragraph", "level": 3, "text": "build_annotation_display_paragraph()" }, { "id": "sphinx_autodoc_typehints_gp.build_resolved_annotation_paragraph", "level": 3, "text": "build_resolved_annotation_paragraph()" }, { "id": "sphinx_autodoc_typehints_gp.build_resolved_annotation_display_paragraph", "level": 3, "text": "build_resolved_annotation_display_paragraph()" }, { "id": "sphinx_autodoc_typehints_gp.render_annotation_nodes", "level": 3, "text": "render_annotation_nodes()" }, { "id": "annotation-text-and-classification", "level": 2, "text": "Annotation text and classification" }, { "id": "sphinx_autodoc_typehints_gp.normalize_annotation_text", "level": 3, "text": "normalize_annotation_text()" }, { "id": "sphinx_autodoc_typehints_gp.normalize_type_collection_text", "level": 3, "text": "normalize_type_collection_text()" }, { "id": "sphinx_autodoc_typehints_gp.classify_annotation_display", "level": 3, "text": "classify_annotation_display()" }, { "id": "sphinx_autodoc_typehints_gp.AnnotationDisplay", "level": 3, "text": "AnnotationDisplay" }, { "id": "sphinx_autodoc_typehints_gp.AnnotationDisplay.text", "level": 4, "text": "text" }, { "id": "sphinx_autodoc_typehints_gp.AnnotationDisplay.is_literal_enum", "level": 4, "text": "is_literal_enum" }, { "id": "sphinx_autodoc_typehints_gp.AnnotationDisplay.literal_members", "level": 4, "text": "literal_members" }, { "id": "sphinx_autodoc_typehints_gp.AnnotationDisplay.__init__", "level": 4, "text": "__init__()" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_autodoc_typehints_gp.setup", "level": 3, "text": "setup()" } ] }, { "title": "Tutorial", "description": "Add sphinx_autodoc_typehints_gp to your extensions list in conf.py:", "section": "Documentation", "url": "/packages/sphinx-autodoc-typehints-gp/tutorial/", "markdownUrl": "/packages/sphinx-autodoc-typehints-gp/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "add-static-type-rendering", "level": 2, "text": "Add static type rendering" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a sphinx-fonts dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/sphinx-fonts/dependents/", "markdownUrl": "/packages/sphinx-fonts/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "How to", "description": "Use this extension when a Sphinx theme should download Fontsource packages, emit @font-face declarations, preload selected font files, and expose font stacks to templates.", "section": "Documentation", "url": "/packages/sphinx-fonts/how-to/", "markdownUrl": "/packages/sphinx-fonts/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "live-specimen", "level": 2, "text": "Live specimen" }, { "id": "template-context", "level": 2, "text": "Template context" }, { "id": "notes", "level": 2, "text": "Notes" } ] }, { "title": "sphinx-fonts", "description": "Alpha GitHub PyPI", "section": "Tokens", "url": "/packages/sphinx-fonts/", "markdownUrl": "/packages/sphinx-fonts/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-fonts" } ] }, { "title": "API Reference", "description": "", "section": "Documentation", "url": "/packages/sphinx-fonts/reference/", "markdownUrl": "/packages/sphinx-fonts/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "configuration-values", "level": 2, "text": "Configuration values" }, { "id": "confval-sphinx_fonts", "level": 3, "text": "sphinx_fonts" }, { "id": "confval-sphinx_font_fallbacks", "level": 3, "text": "sphinx_font_fallbacks" }, { "id": "confval-sphinx_font_css_variables", "level": 3, "text": "sphinx_font_css_variables" }, { "id": "confval-sphinx_font_preload", "level": 3, "text": "sphinx_font_preload" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_fonts.setup", "level": 3, "text": "setup()" } ] }, { "title": "Examples", "description": "Use tree for static project layouts. It highlights connector glyphs, directory names, filenames, and comments without pretending the snippet is a shell transcript.", "section": "Documentation", "url": "/packages/sphinx-gp-highlighting/examples/", "markdownUrl": "/packages/sphinx-gp-highlighting/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "directory-trees", "level": 2, "text": "Directory trees" }, { "id": "inline-literals", "level": 2, "text": "Inline literals" }, { "id": "safe-automatic-highlighting", "level": 2, "text": "Safe automatic highlighting" } ] }, { "title": "How to", "description": "Use the tree lexer for static directory layouts. It highlights connector glyphs, directory names, filenames, and trailing comments without treating the snippet as a shell transcript:", "section": "Documentation", "url": "/packages/sphinx-gp-highlighting/how-to/", "markdownUrl": "/packages/sphinx-gp-highlighting/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "highlight-a-directory-tree", "level": 2, "text": "Highlight a directory tree" }, { "id": "mark-up-inline-commands-and-paths", "level": 2, "text": "Mark up inline commands and paths" }, { "id": "enable-safe-automatic-inline-highlighting", "level": 2, "text": "Enable safe automatic inline highlighting" }, { "id": "use-myst-inline-language-attributes", "level": 2, "text": "Use MyST inline language attributes" } ] }, { "title": "sphinx-gp-highlighting", "description": "Alpha GitHub PyPI", "section": "Highlighting", "url": "/packages/sphinx-gp-highlighting/", "markdownUrl": "/packages/sphinx-gp-highlighting/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-gp-highlighting" } ] }, { "title": "Reference", "description": "sphinx_gp_highlighting/__init__.py.", "section": "Documentation", "url": "/packages/sphinx-gp-highlighting/reference/", "markdownUrl": "/packages/sphinx-gp-highlighting/reference.md", "headings": [ { "id": "", "level": 1, "text": "Reference" }, { "id": "registered-surface", "level": 2, "text": "Registered surface" }, { "id": "lexers", "level": 2, "text": "Lexers" }, { "id": "config-values", "level": 2, "text": "Config values" }, { "id": "confval-gp_highlighting_inline_literals", "level": 3, "text": "gp_highlighting_inline_literals" }, { "id": "confval-gp_highlighting_inline_commands", "level": 3, "text": "gp_highlighting_inline_commands" }, { "id": "roles", "level": 2, "text": "Roles" }, { "id": "role-cmd", "level": 3, "text": ":cmd:" }, { "id": "role-path", "level": 3, "text": ":path:" }, { "id": "role-dir", "level": 3, "text": ":dir:" }, { "id": "api", "level": 2, "text": "API" }, { "id": "sphinx_gp_highlighting.setup", "level": 3, "text": "setup()" }, { "id": "sphinx_gp_highlighting.lexers.DirectoryTreeLexer", "level": 3, "text": "DirectoryTreeLexer" }, { "id": "sphinx_gp_highlighting.lexers.DirectoryTreeLexer.name", "level": 4, "text": "name" }, { "id": "sphinx_gp_highlighting.lexers.DirectoryTreeLexer.aliases", "level": 4, "text": "aliases" }, { "id": "sphinx_gp_highlighting.lexers.DirectoryTreeLexer.filenames", "level": 4, "text": "filenames" }, { "id": "sphinx_gp_highlighting.lexers.DirectoryTreeLexer.mimetypes", "level": 4, "text": "mimetypes" }, { "id": "sphinx_gp_highlighting.lexers.DirectoryTreeLexer.tokens", "level": 4, "text": "tokens" }, { "id": "sphinx_gp_highlighting.lexers.DirectoryTreeLexer.analyse_text", "level": 4, "text": "analyse_text()" }, { "id": "sphinx_gp_highlighting.inline.classify_inline_literal", "level": 3, "text": "classify_inline_literal()" }, { "id": "sphinx_gp_highlighting.inline.build_highlighted_literal", "level": 3, "text": "build_highlighted_literal()" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a sphinx-gp-llms dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/sphinx-gp-llms/dependents/", "markdownUrl": "/packages/sphinx-gp-llms/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "How to", "description": "sphinx_gp_llms ships in DEFAULT_EXTENSIONS, so projects that build through merge_sphinx_config() load it automatically. Passing docs_url= to that function auto-derives the URL input the extension n...", "section": "Documentation", "url": "/packages/sphinx-gp-llms/how-to/", "markdownUrl": "/packages/sphinx-gp-llms/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "integration-with-gp-sphinx", "level": 2, "text": "Integration with gp-sphinx" }, { "id": "output-formats", "level": 2, "text": "Output formats" }, { "id": "llms-txt", "level": 3, "text": "llms.txt" }, { "id": "llms-full-txt", "level": 3, "text": "llms-full.txt" }, { "id": "docs-json", "level": 3, "text": "docs.json" }, { "id": "per-page-md-twins", "level": 3, "text": "Per-page .md twins" }, { "id": "how-the-outputs-are-built", "level": 2, "text": "How the outputs are built" }, { "id": "event-hooks", "level": 2, "text": "Event hooks" }, { "id": "footer-integration", "level": 2, "text": "Footer integration" } ] }, { "title": "sphinx-gp-llms", "description": "Alpha GitHub PyPI", "section": "Build & SEO", "url": "/packages/sphinx-gp-llms/", "markdownUrl": "/packages/sphinx-gp-llms/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-gp-llms" }, { "id": "credits", "level": 2, "text": "Credits" }, { "id": "a-note-on-docs-json", "level": 2, "text": "A note on docs.json" } ] }, { "title": "API Reference", "description": "Generated from add_config_value() registrations in sphinx_gp_llms/__init__.py.", "section": "Documentation", "url": "/packages/sphinx-gp-llms/reference/", "markdownUrl": "/packages/sphinx-gp-llms/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-llms_generate_txt", "level": 3, "text": "llms_generate_txt" }, { "id": "confval-llms_generate_full", "level": 3, "text": "llms_generate_full" }, { "id": "confval-llms_generate_json", "level": 3, "text": "llms_generate_json" }, { "id": "confval-llms_generate_md_twins", "level": 3, "text": "llms_generate_md_twins" }, { "id": "confval-llms_txt_filename", "level": 3, "text": "llms_txt_filename" }, { "id": "confval-llms_full_filename", "level": 3, "text": "llms_full_filename" }, { "id": "confval-llms_json_filename", "level": 3, "text": "llms_json_filename" }, { "id": "confval-llms_excludes", "level": 3, "text": "llms_excludes" }, { "id": "confval-llms_description_length", "level": 3, "text": "llms_description_length" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_gp_llms.setup", "level": 3, "text": "setup()" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a sphinx-gp-mermaid dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/sphinx-gp-mermaid/dependents/", "markdownUrl": "/packages/sphinx-gp-mermaid/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "Examples", "description": "Each diagram below pairs its mermaid source with the dual-theme inline SVG the extension renders it to — the light or dark variant follows the page theme, with no client-side script.", "section": "Documentation", "url": "/packages/sphinx-gp-mermaid/examples/", "markdownUrl": "/packages/sphinx-gp-mermaid/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" } ] }, { "title": "How to", "description": "Write a diagram in a MyST fence — it renders to inline SVG at build time, so it paints with the page and needs no client-side script:", "section": "Documentation", "url": "/packages/sphinx-gp-mermaid/how-to/", "markdownUrl": "/packages/sphinx-gp-mermaid/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "author-a-diagram", "level": 2, "text": "Author a diagram" }, { "id": "choose-the-responsive-policy", "level": 2, "text": "Choose the responsive policy" }, { "id": "install-the-renderer", "level": 2, "text": "Install the renderer" }, { "id": "how-rendering-behaves", "level": 2, "text": "How rendering behaves" } ] }, { "title": "sphinx-gp-mermaid", "description": "Alpha GitHub PyPI", "section": "UX", "url": "/packages/sphinx-gp-mermaid/", "markdownUrl": "/packages/sphinx-gp-mermaid/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-gp-mermaid" } ] }, { "title": "API Reference", "description": "Generated from add_config_value() registrations in sphinx_gp_mermaid/__init__.py.", "section": "Documentation", "url": "/packages/sphinx-gp-mermaid/reference/", "markdownUrl": "/packages/sphinx-gp-mermaid/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-mermaid_cmd", "level": 3, "text": "mermaid_cmd" }, { "id": "confval-mermaid_puppeteer_config", "level": 3, "text": "mermaid_puppeteer_config" }, { "id": "directive-reference", "level": 2, "text": "Directive reference" }, { "id": "directive-mermaid", "level": 3, "text": ".. mermaid::" }, { "id": "directive-option-mermaid-alt", "level": 4, "text": ":alt:" }, { "id": "directive-option-mermaid-caption", "level": 4, "text": ":caption:" }, { "id": "directive-option-mermaid-class", "level": 4, "text": ":class:" }, { "id": "directive-option-mermaid-name", "level": 4, "text": ":name:" }, { "id": "directive-option-mermaid-responsive", "level": 4, "text": ":responsive:" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_gp_mermaid.setup", "level": 3, "text": "setup()" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a sphinx-gp-opengraph dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/sphinx-gp-opengraph/dependents/", "markdownUrl": "/packages/sphinx-gp-opengraph/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "How to", "description": "sphinx_gp_opengraph ships in DEFAULT_EXTENSIONS, so projects that build through merge_sphinx_config() load it automatically. Passing docs_url= to that function auto-derives three of the most common...", "section": "Documentation", "url": "/packages/sphinx-gp-opengraph/how-to/", "markdownUrl": "/packages/sphinx-gp-opengraph/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "integration-with-gp-sphinx", "level": 2, "text": "Integration with gp-sphinx" }, { "id": "how-the-page-level-meta-tags-are-built", "level": 2, "text": "How the page-level meta tags are built" }, { "id": "event-hooks", "level": 2, "text": "Event hooks" }, { "id": "trade-offs", "level": 2, "text": "Trade-offs" } ] }, { "title": "sphinx-gp-opengraph", "description": "Alpha GitHub PyPI", "section": "Build & SEO", "url": "/packages/sphinx-gp-opengraph/", "markdownUrl": "/packages/sphinx-gp-opengraph/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-gp-opengraph" } ] }, { "title": "API Reference", "description": "Generated from add_config_value() registrations in sphinx_gp_opengraph/__init__.py.", "section": "Documentation", "url": "/packages/sphinx-gp-opengraph/reference/", "markdownUrl": "/packages/sphinx-gp-opengraph/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-ogp_site_url", "level": 3, "text": "ogp_site_url" }, { "id": "confval-ogp_canonical_url", "level": 3, "text": "ogp_canonical_url" }, { "id": "confval-ogp_description_length", "level": 3, "text": "ogp_description_length" }, { "id": "confval-ogp_image", "level": 3, "text": "ogp_image" }, { "id": "confval-ogp_image_alt", "level": 3, "text": "ogp_image_alt" }, { "id": "confval-ogp_use_first_image", "level": 3, "text": "ogp_use_first_image" }, { "id": "confval-ogp_type", "level": 3, "text": "ogp_type" }, { "id": "confval-ogp_site_name", "level": 3, "text": "ogp_site_name" }, { "id": "confval-ogp_social_cards", "level": 3, "text": "ogp_social_cards" }, { "id": "confval-ogp_custom_meta_tags", "level": 3, "text": "ogp_custom_meta_tags" }, { "id": "confval-ogp_enable_meta_description", "level": 3, "text": "ogp_enable_meta_description" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_gp_opengraph.setup", "level": 3, "text": "setup()" } ] }, { "title": "Signatures (live)", "description": "Public callables in sphinx_gp_opengraph rendered from the running interpreter at docs-build time. Drift between this block and the prose elsewhere on the page indicates a stale docstring or signatu...", "section": "Documentation", "url": "/packages/sphinx-gp-opengraph/signatures/", "markdownUrl": "/packages/sphinx-gp-opengraph/signatures.md", "headings": [ { "id": "", "level": 1, "text": "Signatures (live)" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a sphinx-gp-sitemap dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/sphinx-gp-sitemap/dependents/", "markdownUrl": "/packages/sphinx-gp-sitemap/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "How to", "description": "sphinx_gp_sitemap ships in DEFAULT_EXTENSIONS, so projects that build through merge_sphinx_config() load it automatically. Passing docs_url= to that function auto-derives both URL inputs the extens...", "section": "Documentation", "url": "/packages/sphinx-gp-sitemap/how-to/", "markdownUrl": "/packages/sphinx-gp-sitemap/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "integration-with-gp-sphinx", "level": 2, "text": "Integration with gp-sphinx" }, { "id": "how-sitemap-xml-is-built", "level": 2, "text": "How sitemap.xml is built" }, { "id": "event-hooks", "level": 2, "text": "Event hooks" }, { "id": "trade-offs", "level": 2, "text": "Trade-offs" } ] }, { "title": "sphinx-gp-sitemap", "description": "Alpha GitHub PyPI", "section": "Build & SEO", "url": "/packages/sphinx-gp-sitemap/", "markdownUrl": "/packages/sphinx-gp-sitemap/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-gp-sitemap" } ] }, { "title": "API Reference", "description": "Generated from add_config_value() registrations in sphinx_gp_sitemap/__init__.py.", "section": "Documentation", "url": "/packages/sphinx-gp-sitemap/reference/", "markdownUrl": "/packages/sphinx-gp-sitemap/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-site_url", "level": 3, "text": "site_url" }, { "id": "confval-sitemap_url_scheme", "level": 3, "text": "sitemap_url_scheme" }, { "id": "confval-sitemap_locales", "level": 3, "text": "sitemap_locales" }, { "id": "confval-sitemap_filename", "level": 3, "text": "sitemap_filename" }, { "id": "confval-sitemap_excludes", "level": 3, "text": "sitemap_excludes" }, { "id": "confval-sitemap_show_lastmod", "level": 3, "text": "sitemap_show_lastmod" }, { "id": "confval-sitemap_indent", "level": 3, "text": "sitemap_indent" }, { "id": "confval-html_baseurl", "level": 3, "text": "html_baseurl" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_gp_sitemap.setup", "level": 3, "text": "setup()" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a sphinx-gp-theme dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/sphinx-gp-theme/dependents/", "markdownUrl": "/packages/sphinx-gp-theme/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "How to", "description": "Use sphinx-gp-theme when a site wants the git-pull Furo layer directly: project metadata, source links, app icons, sidebar project navigation, and the shared static assets.", "section": "Documentation", "url": "/packages/sphinx-gp-theme/how-to/", "markdownUrl": "/packages/sphinx-gp-theme/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "live-theme-notes", "level": 2, "text": "Live theme notes" }, { "id": "theme-options", "level": 2, "text": "Theme options" }, { "id": "bundled-assets", "level": 2, "text": "Bundled assets" }, { "id": "relationship-to-gp-sphinx", "level": 2, "text": "Relationship to gp-sphinx" } ] }, { "title": "sphinx-gp-theme", "description": "Alpha GitHub PyPI", "section": "Theme & coordinator", "url": "/packages/sphinx-gp-theme/", "markdownUrl": "/packages/sphinx-gp-theme/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-gp-theme" } ] }, { "title": "API Reference", "description": "", "section": "Documentation", "url": "/packages/sphinx-gp-theme/reference/", "markdownUrl": "/packages/sphinx-gp-theme/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "theme-helpers", "level": 2, "text": "Theme helpers" }, { "id": "sphinx_gp_theme.get_theme_path", "level": 3, "text": "get_theme_path()" }, { "id": "sphinx_gp_theme.setup", "level": 3, "text": "setup()" }, { "id": "pygments-style", "level": 2, "text": "Pygments style" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle", "level": 3, "text": "GpSphinxLightStyle" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle.name", "level": 4, "text": "name" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle.background_color", "level": 4, "text": "background_color" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle.highlight_color", "level": 4, "text": "highlight_color" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle.line_number_color", "level": 4, "text": "line_number_color" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle.line_number_background_color", "level": 4, "text": "line_number_background_color" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle.line_number_special_color", "level": 4, "text": "line_number_special_color" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle.line_number_special_background_color", "level": 4, "text": "line_number_special_background_color" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle.styles", "level": 4, "text": "styles" }, { "id": "sphinx_gp_theme.pygments_styles.GpSphinxLightStyle._styles", "level": 4, "text": "_styles" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a sphinx-ux-autodoc-layout dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/sphinx-ux-autodoc-layout/dependents/", "markdownUrl": "/packages/sphinx-ux-autodoc-layout/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "Examples", "description": "The class above renders with:", "section": "Documentation", "url": "/packages/sphinx-ux-autodoc-layout/examples/", "markdownUrl": "/packages/sphinx-ux-autodoc-layout/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "module-api_demo_layout", "level": 2, "text": "Live demos" }, { "id": "class-with-members-regions-fold", "level": 3, "text": "Class with members (regions + fold)" }, { "id": "api_demo_layout.LayoutDemo", "level": 4, "text": "LayoutDemo" }, { "id": "api_demo_layout.LayoutDemo.__init__", "level": 5, "text": "__init__()" }, { "id": "api_demo_layout.LayoutDemo.connect", "level": 5, "text": "connect()" }, { "id": "api_demo_layout.LayoutDemo.execute", "level": 5, "text": "execute()" }, { "id": "api_demo_layout.LayoutDemo.close", "level": 5, "text": "close()" }, { "id": "small-function-no-fold", "level": 3, "text": "Small function (no fold)" }, { "id": "api_demo_layout.compact_function", "level": 4, "text": "compact_function()" } ] }, { "title": "How to", "description": "Hooks doctree-resolved at priority 600, after sphinx-autodoc-api-style at 500. Consumes the api_slot nodes that producer packages inject into desc_signature during earlier transforms, and composes ...", "section": "Documentation", "url": "/packages/sphinx-ux-autodoc-layout/how-to/", "markdownUrl": "/packages/sphinx-ux-autodoc-layout/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "pipeline-position", "level": 2, "text": "Pipeline position" }, { "id": "downstream-conf-py", "level": 2, "text": "Downstream conf.py" }, { "id": "find-configuration-values", "level": 2, "text": "Find configuration values" }, { "id": "shared-helper-surface", "level": 2, "text": "Shared helper surface" } ] }, { "title": "sphinx-ux-autodoc-layout", "description": "Alpha GitHub PyPI", "section": "UX", "url": "/packages/sphinx-ux-autodoc-layout/", "markdownUrl": "/packages/sphinx-ux-autodoc-layout/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-ux-autodoc-layout" } ] }, { "title": "API Reference", "description": "Generated from add_config_value() registrations in sphinx_ux_autodoc_layout/__init__.py.", "section": "Documentation", "url": "/packages/sphinx-ux-autodoc-layout/reference/", "markdownUrl": "/packages/sphinx-ux-autodoc-layout/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-api_layout_enabled", "level": 3, "text": "api_layout_enabled" }, { "id": "confval-api_fold_parameters", "level": 3, "text": "api_fold_parameters" }, { "id": "confval-api_collapsed_threshold", "level": 3, "text": "api_collapsed_threshold" }, { "id": "confval-api_signature_show_annotations", "level": 3, "text": "api_signature_show_annotations" }, { "id": "css-classes", "level": 2, "text": "CSS classes" }, { "id": "id1", "level": 2, "text": "API reference" }, { "id": "sphinx_ux_autodoc_layout.build_api_card_entry", "level": 3, "text": "build_api_card_entry()" }, { "id": "sphinx_ux_autodoc_layout.build_api_summary_section", "level": 3, "text": "build_api_summary_section()" }, { "id": "sphinx_ux_autodoc_layout.build_api_table_section", "level": 3, "text": "build_api_table_section()" }, { "id": "sphinx_ux_autodoc_layout.build_api_facts_section", "level": 3, "text": "build_api_facts_section()" }, { "id": "extension-entry-point", "level": 2, "text": "Extension entry point" }, { "id": "sphinx_ux_autodoc_layout.setup", "level": 3, "text": "setup()" } ] }, { "title": "Tutorial", "description": "Render one compact function:", "section": "Documentation", "url": "/packages/sphinx-ux-autodoc-layout/tutorial/", "markdownUrl": "/packages/sphinx-ux-autodoc-layout/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "render-a-compact-api-card", "level": 2, "text": "Render a compact API card" } ] }, { "title": "Dependents", "description": "Workspace packages that declare a sphinx-ux-badges dependency in their pyproject.toml [project].dependencies array.", "section": "Documentation", "url": "/packages/sphinx-ux-badges/dependents/", "markdownUrl": "/packages/sphinx-ux-badges/dependents.md", "headings": [ { "id": "", "level": 1, "text": "Dependents" } ] }, { "title": "Examples", "description": "Every variant rendered by the real build_badge(), build_badge_group(), and build_toolbar() APIs:", "section": "Documentation", "url": "/packages/sphinx-ux-badges/examples/", "markdownUrl": "/packages/sphinx-ux-badges/examples.md", "headings": [ { "id": "", "level": 1, "text": "Examples" }, { "id": "live-demos", "level": 2, "text": "Live demos" } ] }, { "title": "Explanation", "description": "All colour variants are provided by the shared palette above. Downstream extensions reference SAB constants instead of maintaining package-local colour-class palettes.", "section": "Documentation", "url": "/packages/sphinx-ux-badges/explanation/", "markdownUrl": "/packages/sphinx-ux-badges/explanation.md", "headings": [ { "id": "", "level": 1, "text": "Explanation" }, { "id": "downstream-extensions", "level": 2, "text": "Downstream extensions" } ] }, { "title": "sphinx-ux-badges", "description": "Alpha GitHub PyPI", "section": "UX", "url": "/packages/sphinx-ux-badges/", "markdownUrl": "/packages/sphinx-ux-badges/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-ux-badges" } ] }, { "title": "API Reference", "description": "All semantic badge colours live in sab_palettes.css (registered by this extension). Every sphinx-autodoc-* package uses SAB constants instead of its own colour classes. The live demo below shows ...", "section": "Documentation", "url": "/packages/sphinx-ux-badges/reference/", "markdownUrl": "/packages/sphinx-ux-badges/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "colour-palette", "level": 2, "text": "Colour palette" }, { "id": "id1", "level": 2, "text": "API reference" }, { "id": "sphinx_ux_badges.BadgeSpec", "level": 3, "text": "BadgeSpec" }, { "id": "sphinx_ux_badges.BadgeSpec.text", "level": 4, "text": "text" }, { "id": "sphinx_ux_badges.BadgeSpec.tooltip", "level": 4, "text": "tooltip" }, { "id": "sphinx_ux_badges.BadgeSpec.icon", "level": 4, "text": "icon" }, { "id": "sphinx_ux_badges.BadgeSpec.classes", "level": 4, "text": "classes" }, { "id": "sphinx_ux_badges.BadgeSpec.style", "level": 4, "text": "style" }, { "id": "sphinx_ux_badges.BadgeSpec.fill", "level": 4, "text": "fill" }, { "id": "sphinx_ux_badges.BadgeSpec.size", "level": 4, "text": "size" }, { "id": "sphinx_ux_badges.BadgeSpec.tabindex", "level": 4, "text": "tabindex" }, { "id": "sphinx_ux_badges.BadgeSpec.__init__", "level": 4, "text": "__init__()" }, { "id": "sphinx_ux_badges.build_badge_from_spec", "level": 3, "text": "build_badge_from_spec()" }, { "id": "sphinx_ux_badges.build_badge", "level": 3, "text": "build_badge()" }, { "id": "sphinx_ux_badges.build_badge_group", "level": 3, "text": "build_badge_group()" }, { "id": "sphinx_ux_badges.build_toolbar", "level": 3, "text": "build_toolbar()" }, { "id": "sphinx_ux_badges.BadgeNode", "level": 3, "text": "BadgeNode" }, { "id": "sphinx_ux_badges.BadgeNode.__init__", "level": 4, "text": "__init__()" }, { "id": "sphinx_ux_badges.BadgeNode.__new__", "level": 4, "text": "__new__()" }, { "id": "sphinx_ux_badges._css.SAB", "level": 3, "text": "SAB" }, { "id": "sphinx_ux_badges._css.SAB.PREFIX", "level": 4, "text": "PREFIX" }, { "id": "sphinx_ux_badges._css.SAB.BADGE", "level": 4, "text": "BADGE" }, { "id": "sphinx_ux_badges._css.SAB.BADGE_GROUP", "level": 4, "text": "BADGE_GROUP" }, { "id": "sphinx_ux_badges._css.SAB.TOOLBAR", "level": 4, "text": "TOOLBAR" }, { "id": "sphinx_ux_badges._css.SAB.BADGE_LABEL", "level": 4, "text": "BADGE_LABEL" }, { "id": "sphinx_ux_badges._css.SAB.ICON_ONLY", "level": 4, "text": "ICON_ONLY" }, { "id": "sphinx_ux_badges._css.SAB.INLINE_ICON", "level": 4, "text": "INLINE_ICON" }, { "id": "sphinx_ux_badges._css.SAB.OUTLINE", "level": 4, "text": "OUTLINE" }, { "id": "sphinx_ux_badges._css.SAB.FILLED", "level": 4, "text": "FILLED" }, { "id": "sphinx_ux_badges._css.SAB.ICON_RIGHT", "level": 4, "text": "ICON_RIGHT" }, { "id": "sphinx_ux_badges._css.SAB.NO_UNDERLINE", "level": 4, "text": "NO_UNDERLINE" }, { "id": "sphinx_ux_badges._css.SAB.UNDERLINE_DOTTED", "level": 4, "text": "UNDERLINE_DOTTED" }, { "id": "sphinx_ux_badges._css.SAB.UNDERLINE_SOLID", "level": 4, "text": "UNDERLINE_SOLID" }, { "id": "sphinx_ux_badges._css.SAB.XXS", "level": 4, "text": "XXS" }, { "id": "sphinx_ux_badges._css.SAB.XS", "level": 4, "text": "XS" }, { "id": "sphinx_ux_badges._css.SAB.SM", "level": 4, "text": "SM" }, { "id": "sphinx_ux_badges._css.SAB.MD", "level": 4, "text": "MD" }, { "id": "sphinx_ux_badges._css.SAB.LG", "level": 4, "text": "LG" }, { "id": "sphinx_ux_badges._css.SAB.XL", "level": 4, "text": "XL" }, { "id": "sphinx_ux_badges._css.SAB.DENSE", "level": 4, "text": "DENSE" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_FUNCTION", "level": 4, "text": "TYPE_FUNCTION" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_CLASS", "level": 4, "text": "TYPE_CLASS" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_METHOD", "level": 4, "text": "TYPE_METHOD" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_PROPERTY", "level": 4, "text": "TYPE_PROPERTY" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_ATTRIBUTE", "level": 4, "text": "TYPE_ATTRIBUTE" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_DATA", "level": 4, "text": "TYPE_DATA" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_EXCEPTION", "level": 4, "text": "TYPE_EXCEPTION" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_TYPEALIAS", "level": 4, "text": "TYPE_TYPEALIAS" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_MODULE", "level": 4, "text": "TYPE_MODULE" }, { "id": "sphinx_ux_badges._css.SAB.BADGE_TYPE", "level": 4, "text": "BADGE_TYPE" }, { "id": "sphinx_ux_badges._css.SAB.BADGE_MOD", "level": 4, "text": "BADGE_MOD" }, { "id": "sphinx_ux_badges._css.SAB.MOD_ASYNC", "level": 4, "text": "MOD_ASYNC" }, { "id": "sphinx_ux_badges._css.SAB.MOD_CLASSMETHOD", "level": 4, "text": "MOD_CLASSMETHOD" }, { "id": "sphinx_ux_badges._css.SAB.MOD_STATICMETHOD", "level": 4, "text": "MOD_STATICMETHOD" }, { "id": "sphinx_ux_badges._css.SAB.MOD_ABSTRACT", "level": 4, "text": "MOD_ABSTRACT" }, { "id": "sphinx_ux_badges._css.SAB.MOD_FINAL", "level": 4, "text": "MOD_FINAL" }, { "id": "sphinx_ux_badges._css.SAB.MOD_REBUILD", "level": 4, "text": "MOD_REBUILD" }, { "id": "sphinx_ux_badges._css.SAB.STATE_DEPRECATED", "level": 4, "text": "STATE_DEPRECATED" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_FIXTURE", "level": 4, "text": "TYPE_FIXTURE" }, { "id": "sphinx_ux_badges._css.SAB.BADGE_FIXTURE", "level": 4, "text": "BADGE_FIXTURE" }, { "id": "sphinx_ux_badges._css.SAB.BADGE_SCOPE", "level": 4, "text": "BADGE_SCOPE" }, { "id": "sphinx_ux_badges._css.SAB.BADGE_KIND", "level": 4, "text": "BADGE_KIND" }, { "id": "sphinx_ux_badges._css.SAB.BADGE_STATE", "level": 4, "text": "BADGE_STATE" }, { "id": "sphinx_ux_badges._css.SAB.SCOPE_SESSION", "level": 4, "text": "SCOPE_SESSION" }, { "id": "sphinx_ux_badges._css.SAB.SCOPE_MODULE", "level": 4, "text": "SCOPE_MODULE" }, { "id": "sphinx_ux_badges._css.SAB.SCOPE_CLASS", "level": 4, "text": "SCOPE_CLASS" }, { "id": "sphinx_ux_badges._css.SAB.STATE_FACTORY", "level": 4, "text": "STATE_FACTORY" }, { "id": "sphinx_ux_badges._css.SAB.STATE_OVERRIDE", "level": 4, "text": "STATE_OVERRIDE" }, { "id": "sphinx_ux_badges._css.SAB.STATE_AUTOUSE", "level": 4, "text": "STATE_AUTOUSE" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_CONFIG", "level": 4, "text": "TYPE_CONFIG" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_DIRECTIVE", "level": 4, "text": "TYPE_DIRECTIVE" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_ROLE", "level": 4, "text": "TYPE_ROLE" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_OPTION", "level": 4, "text": "TYPE_OPTION" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_TRANSFORM", "level": 4, "text": "TYPE_TRANSFORM" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_READER", "level": 4, "text": "TYPE_READER" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_PARSER", "level": 4, "text": "TYPE_PARSER" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_WRITER", "level": 4, "text": "TYPE_WRITER" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_NODE", "level": 4, "text": "TYPE_NODE" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_TRANSLATOR", "level": 4, "text": "TYPE_TRANSLATOR" }, { "id": "sphinx_ux_badges._css.SAB.MOD_PRIORITY", "level": 4, "text": "MOD_PRIORITY" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_BUILDER", "level": 4, "text": "TYPE_BUILDER" }, { "id": "sphinx_ux_badges._css.SAB.TYPE_DOMAIN", "level": 4, "text": "TYPE_DOMAIN" }, { "id": "sphinx_ux_badges._css.SAB.MOD_FORMAT", "level": 4, "text": "MOD_FORMAT" }, { "id": "sphinx_ux_badges._css.SAB.MOD_DOMAIN_NAME", "level": 4, "text": "MOD_DOMAIN_NAME" }, { "id": "sphinx_ux_badges._css.SAB.META_ALPHA", "level": 4, "text": "META_ALPHA" }, { "id": "sphinx_ux_badges._css.SAB.META_BETA", "level": 4, "text": "META_BETA" }, { "id": "sphinx_ux_badges._css.SAB.META_LINK", "level": 4, "text": "META_LINK" }, { "id": "sphinx_ux_badges._css.SAB.obj_type", "level": 4, "text": "obj_type()" }, { "id": "sphinx_ux_badges._css.SAB.scope", "level": 4, "text": "scope()" }, { "id": "sphinx_ux_badges.setup", "level": 3, "text": "setup()" }, { "id": "css-custom-properties", "level": 2, "text": "CSS custom properties" }, { "id": "defaults", "level": 3, "text": "Defaults" }, { "id": "property-reference", "level": 3, "text": "Property reference" }, { "id": "css-class-reference", "level": 2, "text": "CSS class reference" }, { "id": "context-aware-sizing", "level": 2, "text": "Context-aware sizing" } ] }, { "title": "Tutorial", "description": "sphinx_ux_badges.setup() registers the extension with Sphinx:", "section": "Documentation", "url": "/packages/sphinx-ux-badges/tutorial/", "markdownUrl": "/packages/sphinx-ux-badges/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "build-your-first-badge-toolbar", "level": 2, "text": "Build your first badge toolbar" } ] }, { "title": "How to", "description": "Drop-in replacement for Hatchling’s hatchling.build. Runs pnpm exec vite build before delegating wheel/sdist construction to Hatchling. End users who pip install from PyPI don’t need pnpm or Node —...", "section": "Documentation", "url": "/packages/sphinx-vite-builder/how-to/", "markdownUrl": "/packages/sphinx-vite-builder/how-to.md", "headings": [ { "id": "", "level": 1, "text": "How to" }, { "id": "two-heads-one-core", "level": 2, "text": "Two heads, one core" }, { "id": "pep-517-build-backend", "level": 3, "text": "PEP 517 build backend" }, { "id": "sphinx-extension", "level": 3, "text": "Sphinx extension" }, { "id": "fast-fail-diagnostics", "level": 2, "text": "Fast-fail diagnostics" } ] }, { "title": "sphinx-vite-builder", "description": "Alpha GitHub PyPI", "section": "Build & SEO", "url": "/packages/sphinx-vite-builder/", "markdownUrl": "/packages/sphinx-vite-builder/index.md", "headings": [ { "id": "", "level": 1, "text": "sphinx-vite-builder" } ] }, { "title": "API Reference", "description": "Generated from add_config_value() registrations in sphinx_vite_builder/__init__.py.", "section": "Documentation", "url": "/packages/sphinx-vite-builder/reference/", "markdownUrl": "/packages/sphinx-vite-builder/reference.md", "headings": [ { "id": "", "level": 1, "text": "API Reference" }, { "id": "config-reference", "level": 2, "text": "Config reference" }, { "id": "confval-sphinx_vite_builder_mode", "level": 3, "text": "sphinx_vite_builder_mode" }, { "id": "confval-sphinx_vite_builder_root", "level": 3, "text": "sphinx_vite_builder_root" }, { "id": "pep-517-backend", "level": 2, "text": "PEP 517 backend" }, { "id": "sphinx_vite_builder.build.build_wheel", "level": 3, "text": "build_wheel()" }, { "id": "sphinx_vite_builder.build.build_editable", "level": 3, "text": "build_editable()" }, { "id": "sphinx_vite_builder.build.build_sdist", "level": 3, "text": "build_sdist()" }, { "id": "hatchling-hook", "level": 2, "text": "Hatchling hook" }, { "id": "sphinx_vite_builder.hatch_plugin.ViteBuildHook", "level": 3, "text": "ViteBuildHook" }, { "id": "sphinx_vite_builder.hatch_plugin.ViteBuildHook.PLUGIN_NAME", "level": 4, "text": "PLUGIN_NAME" }, { "id": "sphinx_vite_builder.hatch_plugin.ViteBuildHook.initialize", "level": 4, "text": "initialize()" }, { "id": "sphinx_vite_builder.hatch_plugin.hatch_register_build_hook", "level": 3, "text": "hatch_register_build_hook()" }, { "id": "diagnostic-errors", "level": 2, "text": "Diagnostic errors" }, { "id": "sphinx_vite_builder._internal.errors.SphinxViteBuilderError", "level": 3, "text": "SphinxViteBuilderError" }, { "id": "sphinx_vite_builder._internal.errors.PnpmMissingError", "level": 3, "text": "PnpmMissingError" }, { "id": "sphinx_vite_builder._internal.errors.NodeModulesInstallError", "level": 3, "text": "NodeModulesInstallError" }, { "id": "sphinx_vite_builder._internal.errors.ViteFailedError", "level": 3, "text": "ViteFailedError" } ] }, { "title": "Code Style", "description": "This page split in two when the repository’s agent and contributor documentation moved to .github/:", "section": "Documentation", "url": "/project/code-style/", "markdownUrl": "/project/code-style.md", "headings": [ { "id": "", "level": 1, "text": "Code Style" } ] }, { "title": "Contributing", "description": "Development setup, the gates, and pull request workflow now live in the repository’s own contributing guide, so the same file governs GitHub’s contributing prompt and this published page. Read it o...", "section": "Documentation", "url": "/project/contributing/", "markdownUrl": "/project/contributing.md", "headings": [ { "id": "", "level": 1, "text": "Contributing" }, { "id": "documentation", "level": 2, "text": "Documentation" }, { "id": "test-hierarchy", "level": 2, "text": "Test hierarchy" } ] }, { "title": "Project", "description": "Information for contributors and maintainers.", "section": "Documentation", "url": "/project/", "markdownUrl": "/project/index.md", "headings": [ { "id": "", "level": 1, "text": "Project" } ] }, { "title": "Releasing", "description": "gp-sphinx is pre-1.0. Minor version bumps may include breaking changes.", "section": "Documentation", "url": "/project/releasing/", "markdownUrl": "/project/releasing.md", "headings": [ { "id": "", "level": 1, "text": "Releasing" }, { "id": "version-policy", "level": 2, "text": "Version Policy" }, { "id": "release-process", "level": 2, "text": "Release Process" } ] }, { "title": "Quickstart", "description": "For latest official version:", "section": "Documentation", "url": "/quickstart/", "markdownUrl": "/quickstart.md", "headings": [ { "id": "", "level": 1, "text": "Quickstart" }, { "id": "installation", "level": 2, "text": "Installation" }, { "id": "developmental-releases", "level": 3, "text": "Developmental releases" }, { "id": "usage", "level": 2, "text": "Usage" }, { "id": "adding-extra-extensions", "level": 3, "text": "Adding extra extensions" }, { "id": "removing-default-extensions", "level": 3, "text": "Removing default extensions" }, { "id": "custom-theme-options", "level": 3, "text": "Custom theme options" }, { "id": "your-first-build", "level": 2, "text": "Your first build" }, { "id": "seeing-the-autodoc-design-system", "level": 2, "text": "Seeing the autodoc design system" } ] }, { "title": "What’s new", "description": "gp-sphinx includes a unified autodoc design system: eight major advancements that shape how the documentation stack works. See the gallery for a visual showcase.", "section": "Documentation", "url": "/whats-new/", "markdownUrl": "/whats-new.md", "headings": [ { "id": "", "level": 1, "text": "What’s new" }, { "id": "new-packages", "level": 2, "text": "New packages" }, { "id": "unified-badge-system", "level": 2, "text": "Unified badge system" }, { "id": "shared-layout-stack", "level": 2, "text": "Shared layout stack" }, { "id": "argparse-sphinx-domain", "level": 2, "text": "argparse Sphinx domain" }, { "id": "three-tier-package-organization", "level": 2, "text": "Three-tier package organization" }, { "id": "x-test-speedup", "level": 2, "text": "9.5x test speedup" }, { "id": "snapshot-testing", "level": 2, "text": "Snapshot testing" }, { "id": "doctree-first-testing", "level": 2, "text": "Doctree-first testing" }, { "id": "sphinx-vite-builder-vite-pnpm-orchestration-end-to-end", "level": 2, "text": "sphinx-vite-builder: Vite + pnpm orchestration end-to-end" } ] } ] }