You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
You can find all available options in the docstring of `sphinxext_altair/altairplot.py`. For more examples on how to use this extension, see the test Sphinx documentation in `tests/roots/test-altairplot` or the official [Altair documentation](https://github.com/altair-viz/altair/tree/master/doc).
32
+
You can find all available options in the docstring of `sphinxext_altair/altairplot.py`. For more examples on how to use this extension, see the test Sphinx documentation in `tests/roots/test-altairplot` or the official [Vega-Altair documentation](https://github.com/vega/altair/tree/main/doc).
33
33
34
34
You can install the extension with:
35
35
36
36
```bash
37
37
pip install sphinxext-altair
38
38
```
39
39
40
-
41
40
# Contributing
42
41
It's recommended to use a virtual environment for development:
43
42
@@ -47,17 +46,20 @@ python -m venv .venv
47
46
pip install -e '.[dev]'
48
47
```
49
48
50
-
`sphinxext-altair` uses [black](https://github.com/psf/black) for code formatting, [mypy](https://github.com/python/mypy) for static type checking, [ruff](https://github.com/charliermarsh/ruff) for various linting rules, and [pytest](https://github.com/pytest-dev/pytest) for testing. All these tools can be executed by running:
49
+
`sphinxext-altair` uses [ruff](https://github.com/astral-sh/ruff) for code formatting and linting rules, [mypy](https://github.com/python/mypy) for static type checking, and [pytest](https://github.com/pytest-dev/pytest) for testing.
50
+
All of these tools can be executed by running:
51
51
52
52
```bash
53
-
hatch run test
53
+
hatch test
54
54
```
55
55
56
-
As part of those tests, a Sphinx documentation is built at `tests/roots/test-altairplot`. You can manually build this documentation and view it which is very useful during development of a new feature. For example, if you want to add a new option to the `altair-plot` directive, you can add another example in the file `tests/roots/test-altairplot/index.rst` and then build and view the documentation by running:
56
+
As part of those tests, a Sphinx documentation is built at `tests/roots/test-altairplot`. You can manually build this documentation and view it which is very useful during development of a new feature.
57
+
58
+
For example, if you want to add a new option to the `altair-plot` directive, you can add another example in the file `tests/roots/test-altairplot/index.rst` and then build and view the documentation by running:
57
59
58
60
```bash
59
-
hatch run build-test-docs
60
-
hatch run serve-test-docs
61
+
hatch run doc:clean-build-html
62
+
hatch run doc:serve
61
63
```
62
64
63
65
The test documentation can now be viewed at [http://localhost:8000](http://localhost:8000).
0 commit comments