{ "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()" } ] }, { "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-0-1a27-unreleased", "level": 2, "text": "gp-sphinx 0.0.1a27 (unreleased)" }, { "id": "gp-sphinx-0-0-1a26-2026-05-25", "level": 2, "text": "gp-sphinx 0.0.1a26 (2026-05-25)" }, { "id": "fixes", "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": "id1", "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": "what-s-new", "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": "id2", "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": "id3", "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": "id4", "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": "documentation", "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": "id5", "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": "id6", "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": "id7", "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": "id8", "level": 3, "text": "Bug fixes" }, { "id": "gp-sphinx-mystlexer-highlights-directive-colon-fences", "level": 4, "text": "gp-sphinx: MystLexer highlights :::{directive} colon-fences" }, { "id": "id9", "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": "id10", "level": 3, "text": "What’s new" }, { "id": "new-package-sphinx-vite-builder", "level": 4, "text": "New package: sphinx-vite-builder" }, { "id": "id11", "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": "id12", "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": "id13", "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": "id14", "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": "id15", "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": "id16", "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": "id17", "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": "breaking-changes", "level": 3, "text": "Breaking changes" }, { "id": "id18", "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": "id19", "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": "The asset pipeline lives in packages/gp-furo-theme/web/:", "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": "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": "Shared extension defaults, theme defaults, fonts, MyST, napoleon, copybutton, and rediraffe settings.", "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": "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._abc_impl", "level": 5, "text": "_abc_impl" }, { "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 sphinx_ux_badges.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" } ] }, { "title": "Tutorial", "description": "No special directives are needed — existing .. autofunction::, .. argparse:: block populates a dedicated argparse domain alo...", "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": "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" } ] }, { "title": "Tutorial", "description": "", "section": "Documentation", "url": "/packages/sphinx-autodoc-argparse/tutorial/", "markdownUrl": "/packages/sphinx-autodoc-argparse/tutorial.md", "headings": [ { "id": "", "level": 1, "text": "Tutorial" }, { "id": "working-usage-examples", "level": 2, "text": "Working usage examples" } ] }, { "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" } ] }, { "title": "How to", "description": "sphinx_autodoc_docutils automatically registers sphinx_ux_badges, sphinx_ux_autodoc_layout, and sphinx_autodoc_typehints_gp via app.setup_extension(). You do not need to add them separately to your...", "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" } ] }, { "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": "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": "working-usage-examples", "level": 2, "text": "Working usage examples" } ] }, { "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" } ] }, { "title": "How to", "description": "sphinx_autodoc_fastmcp automatically registers sphinx_ux_badges, sphinx_ux_autodoc_layout, and sphinx_autodoc_typehints_gp via app.setup_extension(). You do not need to add them separately to your ...", "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": "fastmcp-server-module", "level": 2, "text": "fastmcp_server_module" } ] }, { "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 app.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-fastmcp-prompt-input", "level": 3, "text": ".. fastmcp-prompt-input::" }, { "id": "directive-fastmcp-resource", "level": 3, "text": ".. fastmcp-resource::" }, { "id": "directive-fastmcp-resource-template", "level": 3, "text": ".. fastmcp-resource-template::" }, { "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-badge", "level": 3, "text": ":badge:" } ] }, { "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": "working-usage-examples", "level": 2, "text": "Working usage examples" }, { "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": "when-to-use-auto-pytest-plugin", "level": 4, "text": "When to use auto-pytest-plugin" }, { "id": "autofixtures-options", "level": 4, "text": "autofixtures 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": "sphinx_autodoc_pytest_fixtures automatically registers sphinx_ux_badges, sphinx_ux_autodoc_layout, and sphinx_autodoc_typehints_gp via app.setup_extension(). You do not need to add them separately ...", "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": "registered-configuration-values", "level": 2, "text": "Registered configuration values" }, { "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" } ] }, { "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": "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": "working-usage-examples", "level": 2, "text": "Working usage examples" } ] }, { "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" } ] }, { "title": "How to", "description": "sphinx_autodoc_sphinx automatically registers sphinx_ux_badges, sphinx_ux_autodoc_layout, and sphinx_autodoc_typehints_gp via app.setup_extension(). You do not need to add them separately to your e...", "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" } ] }, { "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 app.add_directive() registrations in sphinx_autodoc_sphinx/__init__.py via sphinx-autodoc-docutils — a meta-loop where the package that documents config values uses its sibling packa...", "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:" } ] }, { "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": "working-usage-examples", "level": 2, "text": "Working usage examples" } ] }, { "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": "Two hooks run independently:", "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": "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": "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": "working-usage-examples", "level": 2, "text": "Working usage examples" } ] }, { "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": "This site uses sphinx-fonts, so the samples below are rendered with the same template context that downstream themes receive.", "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" } ] }, { "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 app.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" } ] }, { "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 app.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" } ] }, { "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 app.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" } ] }, { "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": "This site is rendered with sphinx-gp-theme.", "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": "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": "configuration", "level": 2, "text": "Configuration" }, { "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": "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": "Class", "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": "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()" } ] }, { "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": "working-usage-examples", "level": 2, "text": "Working usage examples" } ] }, { "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 / build_toolbar API:", "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 their own sab-* / spf-* / sas-* / sadoc-* colour classes.", "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 the SAB.* constants instead of its own colour classes. The live demo below ...", "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.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": "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": "working-usage-examples", "level": 2, "text": "Working usage examples" } ] }, { "title": "How to", "description": "Drop-in replacement for 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 — the wheel s...", "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": "Code Style", "description": "gp-sphinx uses ruff for both linting and formatting.", "section": "Documentation", "url": "/project/code-style/", "markdownUrl": "/project/code-style.md", "headings": [ { "id": "", "level": 1, "text": "Code Style" }, { "id": "formatting", "level": 2, "text": "Formatting" }, { "id": "type-checking", "level": 2, "text": "Type Checking" }, { "id": "docstrings", "level": 2, "text": "Docstrings" } ] }, { "title": "Contributing", "description": "Install git and uv.", "section": "Documentation", "url": "/project/contributing/", "markdownUrl": "/project/contributing.md", "headings": [ { "id": "", "level": 1, "text": "Contributing" }, { "id": "tests", "level": 2, "text": "Tests" }, { "id": "automatically-run-tests-on-file-save", "level": 3, "text": "Automatically run tests on file save" }, { "id": "documentation", "level": 2, "text": "Documentation" }, { "id": "manual-documentation-the-hard-way", "level": 3, "text": "Manual documentation (the hard way)" }, { "id": "test-hierarchy", "level": 2, "text": "Test hierarchy" }, { "id": "scenario-caching", "level": 3, "text": "Scenario caching" }, { "id": "snapshot-testing", "level": 3, "text": "Snapshot testing" } ] }, { "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": "The autodoc-improvements branch introduces a unified autodoc design system — eight major advancements that transform 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" } ] } ] }