sphinxext-altair

sphinxext-altair 提供了指令 altair-plot，可在您的Sphinx文档中插入实时渲染的Altair图表

    .. altair-plot::
        import altair as alt
        from vega_datasets import data


        cars = data.cars()

        alt.Chart(cars).mark_point().encode(
            x='Horsepower',
            y='Miles_per_Gallon',
            color='Origin',
            shape='Origin'
        )

您可以通过将其添加到 conf.py 中来启用此扩展

extensions = [
    ...
    "sphinxext_altair.altairplot",
    ...
]

您可以在 sphinxext_altair/altairplot.py 的文档字符串中找到所有可用选项。有关如何使用此扩展的更多示例，请参阅 tests/roots/test-altairplot 中的测试Sphinx文档或官方 Altair文档。

您可以使用以下方式安装此扩展：

pip install sphinxext-altair

贡献

建议在开发时使用虚拟环境

python -m venv .venv
# Install the project in editable mode including development dependencies
pip install -e '.[dev]'

sphinxext-altair 使用 black 进行代码格式化，使用 mypy 进行静态类型检查，使用 ruff 进行各种代码检查规则，以及使用 pytest 进行测试。所有这些工具都可以通过运行以下命令执行：

hatch run test

作为这些测试的一部分，Sphinx 文档在 tests/roots/test-altairplot 中构建。您可以手动构建此文档并查看它，这在开发新功能时非常有用。例如，如果您想向 altair-plot 指令添加新选项，您可以在文件 tests/roots/test-altairplot/index.rst 中添加另一个示例，然后通过运行以下命令来构建和查看文档：

hatch run build-test-docs
hatch run serve-test-docs

测试文档现在可以在 http://localhost:8000 上查看。