vizro-mcp

site_name: Vizro site_url: https://vizro.readthedocs.io/en/stable/ nav: # Make sure any new page added here is also added to the llmstxt plugin below (around line 156) - Vizro: index.md - Tutorials: - Quickstart tutorial: pages/tutorials/quickstart-tutorial.md - Explore Vizro: pages/tutorials/explore-components.md - Write your own actions: pages/tutorials/custom-actions-tutorial.md - How-to guides: - Fundamentals: - Install Vizro: pages/user-guides/install.md - Dashboard: pages/user-guides/dashboard.md - Page: pages/user-guides/pages.md - Run or deploy dashboards: pages/user-guides/run-deploy.md - Components: - Overview: pages/user-guides/components.md - Graph: pages/user-guides/graph.md - Table: pages/user-guides/table.md - Figure: pages/user-guides/figure.md - Card: pages/user-guides/card.md - Text: pages/user-guides/text.md - Button: pages/user-guides/button.md - Container: pages/user-guides/container.md - Tab: pages/user-guides/tabs.md - Controls: - Overview: pages/user-guides/controls.md - Filter: pages/user-guides/filters.md - Parameter: pages/user-guides/parameters.md - Selector: pages/user-guides/selectors.md - Navigation: pages/user-guides/navigation.md - Actions: - Overview: pages/user-guides/actions.md - Handle data: pages/user-guides/data-actions.md - Graph and table interactions: pages/user-guides/graph-table-actions.md - Visual formatting: - Overview: pages/user-guides/visual-formatting.md - Layout: pages/user-guides/layouts.md - Theme: pages/user-guides/themes.md - Assets: pages/user-guides/assets.md - Custom CSS: pages/user-guides/custom-css.md - Data: - Overview: pages/user-guides/data.md - Kedro Data Catalog: pages/user-guides/kedro-data-catalog.md - Extensions: - Overview: pages/user-guides/extensions.md - Custom actions: pages/user-guides/custom-actions.md - Custom charts: pages/user-guides/custom-charts.md - Custom tables: pages/user-guides/custom-tables.md - Custom figures: pages/user-guides/custom-figures.md - Custom components: pages/user-guides/custom-components.md - API reference: - Vizro: pages/API-reference/vizro.md - Models: pages/API-reference/models.md - Actions: pages/API-reference/actions.md - Table functions: pages/API-reference/table-callables.md - Figure functions: pages/API-reference/figure-callables.md - Kedro integration: pages/API-reference/kedro-integration.md - Deprecations: pages/API-reference/deprecations.md - Find out more: - Technical: - Vizro schema: pages/explanation/schema.md - Actions: pages/explanation/actions-explanation.md - About Vizro: - FAQs: pages/explanation/faq.md - User examples: pages/explanation/your-examples.md - Cheatsheet: pages/cheatsheet/cheatsheet.html - Contribute to Vizro: pages/explanation/contributing.md - Documentation style: pages/explanation/documentation-style-guide.md - Authors: pages/explanation/authors.md - Vizro-MCP: - Vizro-MCP: https://vizro.readthedocs.io/projects/vizro-mcp/ repo_url: https://github.com/mckinsey/vizro repo_name: mckinsey/vizro theme: name: material language: en custom_dir: docs/overrides palette: - scheme: default font: text: Google sans code: Source Code Pro icon: repo: fontawesome/brands/github features: - navigation.expand - navigation.instant - navigation.indexes - navigation.tabs - navigation.tabs.sticky - navigation.tracking - search.suggest - search.highlight - content.tabs.link - content.code.annotation - content.code.copy - content.code.annotate watch: - src markdown_extensions: - pymdownx.highlight: anchor_linenums: true - pymdownx.inlinehilite - pymdownx.snippets - admonition - pymdownx.arithmatex: generic: true - footnotes - pymdownx.keys - pymdownx.details - pymdownx.superfences: custom_fences: - name: mermaid class: mermaid format: !!python/name:pymdownx.superfences.fence_code_format - name: python class: "highlight" validator: !!python/name:mkdocs_pycafe.validator format: !!python/object/apply:mkdocs_pycafe.formatter kwds: type: vizro requirements: | vizro==0.1.48 - pymdownx.tabbed: alternate_style: true - pymdownx.mark - md_in_html - attr_list - pymdownx.emoji: emoji_index: !!python/name:material.extensions.emoji.twemoji emoji_generator: !!python/name:material.extensions.emoji.to_svg plugins: - search - autorefs - llmstxt: # https://pypi.org/project/mkdocs-llmstxt/ markdown_description: Vizro is an open-source Python-based toolkit to build data visualization apps. Every Vizro app is defined by a simple configuration, using the high-level categories * Components (charts, tables, cards, KPI indicators, forms and more), * Controls (filters and parameters, using a range of selectors such as drop-down menus and sliders), * Actions (interactions between components, drill-throughs, export functionality and more), * Layouts (grid layouts or flexible containers, with a range of pre-set styles), * Navigation (a range of app layout and navigation settings, including nested page hierarchies). Configuration can be written in multiple formats including Pydantic models, JSON, YAML or Python dictionaries for added flexibility of implementation. Optional high-code extensions enable almost infinite customization in a modular way, combining the best of low-code and high-code - including bespoke visual formatting and custom components. base_url: https://vizro.readthedocs.io/en/0.1.48/ full_output: llms-full.txt sections: "TUTORIALS": - pages/tutorials/quickstart-tutorial.md: "A quickstart dashboard tutorial" - pages/tutorials/explore-components.md: "An in-depth tutorial to introduce Vizro's key features (accompanying Video is available)" "FUNDAMENTAL CONCEPTS IN VIZRO": - pages/user-guides/install.md: "Guide on how to install Vizro" - pages/user-guides/dashboard.md: "Dashboard basics" - pages/user-guides/pages.md: "Pages" - pages/user-guides/run-deploy.md: "How to run or deploy dashboards" "LEARN ABOUT VIZRO COMPONENTS": - pages/user-guides/components.md: "Components overview" - pages/user-guides/graph.md: "Graphs" - pages/user-guides/table.md: "Tables" - pages/user-guides/figure.md: "Figures" - pages/user-guides/card.md: "Cards" - pages/user-guides/text.md: "Text" - pages/user-guides/button.md: "Buttons" - pages/user-guides/container.md: "Containers" - pages/user-guides/tabs.md: "Tabs" "ADD CONTROLS TO A DASHBOARD": - pages/user-guides/controls.md: "Controls overview" - pages/user-guides/filters.md: "Filters" - pages/user-guides/parameters.md: "Parameters" - pages/user-guides/selectors.md: "Selectors" "DASHBOARD NAVIGATION ELEMENTS": - pages/user-guides/navigation.md: "Navigation" "HOW TO APPLY VISUAL FORMATTING": - pages/user-guides/visual-formatting.md: "Formatting overview" - pages/user-guides/layouts.md: "Layouts" - pages/user-guides/themes.md: "Themes" - pages/user-guides/assets.md: "Assets" - pages/user-guides/custom-css.md: "Custom CSS" "ACTIONS": - pages/user-guides/actions.md: "Actions" - pages/user-guides/data-actions.md: "Handle data" - pages/user-guides/graph-table-actions.md: "Graph and table interactions" "MANAGE DATA USED BY THE DASHBOARD": - pages/user-guides/data.md: "Data" - pages/user-guides/kedro-data-catalog.md: "Kedro Data Catalog" "EXTEND THE DASHBOARD WITH CUSTOMIZATIONS": - pages/user-guides/extensions.md: "Extensions overview" - pages/user-guides/custom-charts.md: "Custom charts" - pages/user-guides/custom-tables.md: "Custom tables" - pages/user-guides/custom-components.md: "Custom components" - pages/user-guides/custom-actions.md: "Custom actions" - pages/user-guides/custom-figures.md: "Custom figures" "FAQS, EXAMPLES, CONTRIBUTION GUIDANCE AND THE VIZRO SCHEMA": - pages/explanation/faq.md: "FAQs" - pages/explanation/your-examples.md: "Examples created by the Vizro community" - pages/explanation/contributing.md: "How to contribute to Vizro's open source project" - pages/explanation/documentation-style-guide.md: "Documentation style guide" - pages/explanation/schema.md: "The Vizro schema" - pages/explanation/authors.md: "Vizro contributor listing" - mkdocstrings: handlers: python: options: show_bases: false show_source: false #currently doesn't show source at correct level, and not for pydantic models docstring_style: google merge_init_into_class: true docstring_section_style: list separate_signature: true # filters: ["!^_"] show_root_heading: true docstring_options: ignore_init_summary: true warn_unknown_params: false returns_named_value: false extensions: - docs/griffe_extensions.py: paths: [vizro.figures.kpi_card, vizro.figures.kpi_card_reference] - griffe_warnings_deprecated: kind: danger title: Deprecated paths: [src] - git-revision-date-localized: enable_creation_date: false extra: meta: - name: google-site-verification content: "CYb3cxosCgsN2QDQVaSGQpMQCesqpsGQ3oTM02NtvkY" extra_css: - stylesheets/extra.css extra_javascript: - javascripts/extra.js # Strictest settings possible, and will be elevated to ERROR when run with --strict. # See https://www.mkdocs.org/user-guide/configuration/#validation. validation: omitted_files: warn absolute_links: warn unrecognized_links: warn anchors: warn