Contribute to this project
Contribute to this project¶
✨ Welcome we’re excited you’re here and want to contribute. ✨
Be sure to check out our Code of Conduct
This project and its community follows this Code of Conduct to ensure that our online spaces are enjoyable, inclusive, and productive for all contributors.
Getting started (contributing to this site)¶
Setting your local environment¶
To get started with the codebase, take the following steps:
Clone the repository, from your terminal:
git clone https://github.com/Quansight-Labs/jupyter-a11y-mgmt
Install needed dependencies
We recommend using Python
3.8to build the project as it is the version we are currently using to deploy the site.
# Install nox pip install nox --user
Build and serve the site locally with
nox --session live_docs
Running this command will install
jupyter-bookin a virtual environment and build the output in
docs/_build. Runnign this command will use
sphinx-autobuildto build the documentation site and start watching for changes in
docs/. It will also start a server at
🎉 Once you have your server up and running you can head to http://127.0.0.1:5500/ on your web browser of choice and get started.
To stop the server you will need to type Ctrl + C on your terminal.