altairplot.py: I copied it over from Altair in the first commit and added some type hints and did smaller docstring improvements in subsequent commits. I therefore think this does not require a detailed review.
Package management related files, README, etc.: I tried to keep these as close as possible to the altair repo
tests: Tests are inspired by some other sphinx extensions and by the sphinx repo itself which uses the same folder structure and approach to test directives.
The README.md has some instructions on how this package can be manually tested if required by building the test documentation. Furthermore, I created a PR over in the altair repo https://github.com/altair-viz/altair/pull/3056 which uses the code from this branch to build the whole altair documentation. That worked well without any issues.
Not sure why workflows are not yet executed, do they need to be merged first at least once? They are executed in my fork so you can view the status there: https://github.com/binste/sphinxext-altair/actions
Happy to do a release on pypi once this gets approved and add @mattijn and @joelostblom as maintainers as well. I can of course also add more if you want.
See https://github.com/altair-viz/altair/issues/3051 for context.
For the review:
altairplot.py
: I copied it over from Altair in the first commit and added some type hints and did smaller docstring improvements in subsequent commits. I therefore think this does not require a detailed review.tests
: Tests are inspired by some other sphinx extensions and by the sphinx repo itself which uses the same folder structure and approach to test directives.The
README.md
has some instructions on how this package can be manually tested if required by building the test documentation. Furthermore, I created a PR over in the altair repo https://github.com/altair-viz/altair/pull/3056 which uses the code from this branch to build the whole altair documentation. That worked well without any issues.Not sure why workflows are not yet executed, do they need to be merged first at least once? They are executed in my fork so you can view the status there: https://github.com/binste/sphinxext-altair/actions
Happy to do a release on pypi once this gets approved and add @mattijn and @joelostblom as maintainers as well. I can of course also add more if you want.