DEVELOPER.md

developing and using the nbconvert_a11y python module

this project digs hooks into nbconvert to modify the accessible experience for static jupyter notebooks.

all of the developer steps are invoked using the hatch development tool.

pip install hatch                     # install the hatch developer tooling
hatch run test:run                    # runs the test
hatch run task:export                 # exports docs and audits of notebooks
hatch -e task run doit list           # run arbitrary doit commands
hatch run docs:build                  # run arbitrary doit commands

more implementation details can be found in the github actions for testing the project, exporting the converted artifacts, and building the docs.