Skip to content

Commit

Permalink
docs: Update README.md (#11)
Browse files Browse the repository at this point in the history
* docs: Update `black`, `ruff` references

* docs: Update `hatch` commands

* docs: Tweak formatting/whitespace

* docs: Update refs to use `"Vega-Altair"`
  • Loading branch information
dangotbanned authored Aug 29, 2024
1 parent cc6330f commit 7940667
Showing 1 changed file with 20 additions and 18 deletions.
38 changes: 20 additions & 18 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
# sphinxext-altair
**sphinxext-altair** provides the directive `altair-plot` to insert live-rendered Altair plots within your Sphinx documentation:
**sphinxext-altair** provides the directive `altair-plot` to insert live-rendered Vega-Altair plots within your Sphinx documentation:

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


cars = data.cars()
cars = data.cars()

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

<img src="https://raw.githubusercontent.com/altair-viz/sphinxext-altair/main/images/example_screenshot.png" width="70%">
Expand All @@ -29,15 +29,14 @@ extensions = [
]
```

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).
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).

You can install the extension with:

```bash
pip install sphinxext-altair
```


# Contributing
It's recommended to use a virtual environment for development:

Expand All @@ -47,17 +46,20 @@ python -m venv .venv
pip install -e '.[dev]'
```

`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:
`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.
All of these tools can be executed by running:

```bash
hatch run test
hatch test
```

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:
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:

```bash
hatch run build-test-docs
hatch run serve-test-docs
hatch run doc:clean-build-html
hatch run doc:serve
```

The test documentation can now be viewed at [http://localhost:8000](http://localhost:8000).

0 comments on commit 7940667

Please sign in to comment.