Skip to main content
Ctrl+K
Logo image
0.15.1

Site Navigation

  • Getting Started
  • Example Gallery
  • User Guide
  • API Reference
  • Community
  • Contributing
  • About

Site Navigation

  • Getting Started
  • Example Gallery
  • User Guide
  • API Reference
  • Community
  • Contributing
  • About

Section Navigation

Contribution types

  • Issue reports
  • Translate ArviZ website and documentation
  • Issue Triaging
  • Outreach
  • Review PRs
  • Contributing code via pull requests

Tutorials

  • Pull request step-by-step

How-to guides

  • Building the documentation
  • Updating the example data
  • Running the benchmark suite
  • How to make a new release
  • How to add to the Example Gallery

Reference

  • Pull request checklist
  • Library architecture
  • Documentation content structure
  • Docstring style
  • Written content formatting reference
  • Developing in Docker

In depth explanations

  • Documentation toolchain
  • Diátaxis for ArviZ
  • Plotting backends
  • Contributing to ArviZ
  • How to add to the Example Gallery

How to add to the Example Gallery#

Matplotlib file is required for the chart to appear in the Example gallery. Bokeh uses the same metadata as long as the Plot Title and {plot_name} are the same.

Use the templates below to create new charts.

{Metadata}

Description

Plot Title

Title of the chart shown in example gallery and table of contents

Gallery Category

Single Category in example gallery and table of contents, defaults to Miscellaneous

Alt Text

Text for overlay and alternative text for img thumbnail

Gallery Categories

[
    "Mixed Plots",
    "Distributions",
    "Distribution Comparison",
    "Inference Diagnostics",
    "Regression or Time Series",
    "Model Comparison",
    "Model Checking",
    "Miscellaneous",
    "Styles",
]

Matplotlib Template (Required)#

Create mpl_plot_{plot_name}.py under matplotlib/.

"""
{Plot Title}
=========
_gallery_category: {Gallery Category}
_alt_text: {Alt Text}
"""
{Additional imports here}

import arviz as az

az.style.use("arviz-doc")

{Additional code here}

Bokeh Template#

Create bokeh_plot_{plot_name}.py under matplotlib/.

"""
{Plot Title, must match the one in Matplotlib}
=========
"""
{Additional imports here}

import arviz as az

az.style.use("arviz-doc")

{Additional code here}

previous

How to make a new release

next

Pull request checklist

On this page
  • Matplotlib Template (Required)
  • Bokeh Template
Edit on GitHub
Show Source
Support ArviZ

© Copyright 2018, ArviZ devs.

Created using Sphinx 5.3.0.

Built with the PyData Sphinx Theme 0.13.1.