ARCHITECTURE.md

Architecture document for the jupyter/accessibility repository

• Architecture document for the jupyter/accessibility repository
  • 🗺️ Code Map
    • 📖 /docs
    • jupyter-book configuration files
    • ☑️ /testing
    • /testing/tools
    • /testing/jupyterlab
    • /testing/notebooks

Introduction

Accessibility is a cross-cutting concern in Project Jupyter. This repository exists as a monorepo to incubate accessibility tooling and resources. In this repository, you will find the following:

1. The Binder configuration files
2. GitHub workflows and issues templates
3. Sphinx documentation for the accessibility project
4. The ja11y python module

Code Map

This section talks briefly about various important directories and data structures. When adding new tools or tests make sure to follow the convention of files and directories already established.

.
├── .binder
├── .github
├── docs
├── pa11y-jupyter
├── .readthedocs.yaml
├── ARCHITECTURE.md
├── CONTRIBUTING.md
├── LICENSE
├── noxfile.py
├── README.md
├── repos.toml
└── repos.yml

/docs

Contains the source for the Jupyter accessibility documentation as well as the requirements file. The docs are built using JupyterBook and ReadTheDocs. To build the documentation locally run the following command:

    nox -s docs # build the documentation

jupyter-book configuration files

• docs/_toc.yml: the table of contents. For more details on structuring docs using JupyterBook visit the documentation for the table of contents
• docs/_config.yml: documentation configuration file. To learn more about the configuration options on JupyterBook visit their configuration documentation page