Skip to content

Commit

Permalink
deploy: f73f90f
Browse files Browse the repository at this point in the history
  • Loading branch information
balajialg committed Sep 18, 2023
1 parent c59a71c commit d4a4dfb
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 10 deletions.
8 changes: 3 additions & 5 deletions _sources/workflow/accessibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ The Datahub team constantly collaborates with Jupyter developers to incorporate

### JupyterLab 4.0:

A number of accessibility improvements have been made in JupyterLab 4.0, including improved screen reader and keyboard navigation, more ARIA roles and labels, and a hamburger menu that collapses if there is not enough space to display all items. You can read more about the features of Lab 4 in the blogpost titled JupyterLab 4.0 is here. Lab 4 has undergone extensive testing with Data 100 summer 23 instructors within a new hub, and the overall experience has been positive, with the exception of real-time collaboration, which may require further attention.
A number of accessibility improvements have been made in JupyterLab 4.0, including improved screen reader and keyboard navigation, more ARIA roles and labels, and a hamburger menu that collapses if there is not enough space to display all items. You can read more about the features of Lab 4 in the blogpost titled ["JupyterLab 4.0 is here"](https://blog.jupyter.org/jupyterlab-4-0-is-here-388d05e03442). Lab 4 has undergone extensive testing with Data 100 summer 23 instructors within a new hub, and the overall experience has been positive, with the exception of real-time collaboration, which may require further attention.

### Jupyter Notebook 7.0:

Expand All @@ -30,7 +30,7 @@ Sharing couple of resources from the [Iota School](https://github.com/Iota-Schoo

#### Export notebook to html format:

The editable notebook format (.ipynb) is inaccessible for screen readers and keyboard navigation. Lot of effort has been made to Lab 4 and Notbook 7 to overcome some of the barriers to accessibility. However, it is still not 100% accessible at the moment. To improve the readability of the notebooks, It is recommended that .ipynb files are converted to .html files which are largely designed for web and has a more accessible experience. It is recommended that .ipynb files are not converted to PDF for readability as PDFs are generally inaccessible in comparison to html format.
The editable notebook format (.ipynb) is inaccessible for screen readers and keyboard navigation. Lot of effort has been made to Lab 4 and Notbook 7 to overcome some of the barriers to accessibility. However, it is still not 100% accessible at the moment. To improve the readability of the notebooks, It is recommended that .ipynb files are converted to .html files which are largely designed for webinterface and has a more accessible experience. PDFs are generally inaccessible in comparison to html format from a readability standpoint.

[Nbconvert](https://github.com/jupyter/nbconvert) is a tool that converts notebooks to various formats including html which improves readability. The command for converting notebooks from .ipynb to html is

Expand All @@ -44,9 +44,7 @@ Jupyter Classic Notebook and Lab have 3rd party themes that give more control to

[JupyterLab-Accessible-Themes](https://github.com/Quansight-Labs/jupyterlab-accessible-themes) is a lab theme that allows notebook creators to customize the lab experience. There are two different types of themes which are included as part of this package,
a) Pitaya Smoothie and
b) Github Light

Both the themes are WCAG 2.1 AAA compliant and have been recommended by the Jupyter a11y community. However, these themes are not compatible with classic notebook interface.
b) Github Light. Both the themes are WCAG 2.1 AAA compliant and have been recommended by the Jupyter a11y community. However, these themes are not compatible with classic notebook interface.

[Jupyter Themes](https://github.com/dunovank/jupyter-themes) is a notebook theme that offers 7 different types of themes to customize the classic notebook experience. This theme only works with classic notebook interface and is not compatible with JupyterLab and the Notebook 7.0. The different types of themes are onedork, grade3, oceans16, chesterish, monokai, solarizedI, solarizedd. You can explore these themes using the documentation in [this web page](https://github.com/dunovank/jupyter-themes). If you are looking for JupyterLab equivalent for those themes then you can explore JupyterLab [Legos UI](https://github.com/dunovank/jupyterlab_legos_ui) and [Darkside UI](https://github.com/dunovank/jupyterlab_darkside_ui)

Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

7 changes: 3 additions & 4 deletions workflow/accessibility.html
Original file line number Diff line number Diff line change
Expand Up @@ -412,7 +412,7 @@ <h2>Enhancing the accessibility of the notebook interface:<a class="headerlink"
<p>The Datahub team constantly collaborates with Jupyter developers to incorporate accessibility enhancements into both the Notebook and Lab interfaces. In that spirit, We encourage instructors to integrate Lab 4 and Notebook 7 into their teaching workflows, as these releases include the latest accessibility enhancements.</p>
<section id="jupyterlab-4-0">
<h3>JupyterLab 4.0:<a class="headerlink" href="#jupyterlab-4-0" title="Permalink to this heading">#</a></h3>
<p>A number of accessibility improvements have been made in JupyterLab 4.0, including improved screen reader and keyboard navigation, more ARIA roles and labels, and a hamburger menu that collapses if there is not enough space to display all items. You can read more about the features of Lab 4 in the blogpost titled JupyterLab 4.0 is here. Lab 4 has undergone extensive testing with Data 100 summer 23 instructors within a new hub, and the overall experience has been positive, with the exception of real-time collaboration, which may require further attention.</p>
<p>A number of accessibility improvements have been made in JupyterLab 4.0, including improved screen reader and keyboard navigation, more ARIA roles and labels, and a hamburger menu that collapses if there is not enough space to display all items. You can read more about the features of Lab 4 in the blogpost titled <a class="reference external" href="https://blog.jupyter.org/jupyterlab-4-0-is-here-388d05e03442">JupyterLab 4.0 is here</a>. Lab 4 has undergone extensive testing with Data 100 summer 23 instructors within a new hub, and the overall experience has been positive, with the exception of real-time collaboration, which may require further attention.</p>
</section>
<section id="jupyter-notebook-7-0">
<h3>Jupyter Notebook 7.0:<a class="headerlink" href="#jupyter-notebook-7-0" title="Permalink to this heading">#</a></h3>
Expand All @@ -429,7 +429,7 @@ <h2>Enhancing the accessibility of the content within Jupyter notebooks:<a class
</ul>
<section id="export-notebook-to-html-format">
<h3>Export notebook to html format:<a class="headerlink" href="#export-notebook-to-html-format" title="Permalink to this heading">#</a></h3>
<p>The editable notebook format (.ipynb) is inaccessible for screen readers and keyboard navigation. Lot of effort has been made to Lab 4 and Notbook 7 to overcome some of the barriers to accessibility. However, it is still not 100% accessible at the moment. To improve the readability of the notebooks, It is recommended that .ipynb files are converted to .html files which are largely designed for web and has a more accessible experience. It is recommended that .ipynb files are not converted to PDF for readability as PDFs are generally inaccessible in comparison to html format.</p>
<p>The editable notebook format (.ipynb) is inaccessible for screen readers and keyboard navigation. Lot of effort has been made to Lab 4 and Notbook 7 to overcome some of the barriers to accessibility. However, it is still not 100% accessible at the moment. To improve the readability of the notebooks, It is recommended that .ipynb files are converted to .html files which are largely designed for webinterface and has a more accessible experience. PDFs are generally inaccessible in comparison to html format from a readability standpoint.</p>
<p><a class="reference external" href="https://github.com/jupyter/nbconvert">Nbconvert</a> is a tool that converts notebooks to various formats including html which improves readability. The command for converting notebooks from .ipynb to html is</p>
<p><code class="docutils literal notranslate"><span class="pre">$</span> <span class="pre">jupyter</span> <span class="pre">nbconvert</span> <span class="pre">--to</span> <span class="pre">html</span> <span class="pre">mynotebook.ipynb</span></code></p>
<p>One can also customize the themes, font types, sizes etc. as part of the notebook inorder to improve the accessibility.</p>
Expand All @@ -439,8 +439,7 @@ <h3>Notebook Themes:<a class="headerlink" href="#notebook-themes" title="Permali
<p>Jupyter Classic Notebook and Lab have 3rd party themes that give more control to the notebook developers to customize the notebook themes and improve accessibility as a result .</p>
<p><a class="reference external" href="https://github.com/Quansight-Labs/jupyterlab-accessible-themes">JupyterLab-Accessible-Themes</a> is a lab theme that allows notebook creators to customize the lab experience. There are two different types of themes which are included as part of this package,
a) Pitaya Smoothie and
b) Github Light</p>
<p>Both the themes are WCAG 2.1 AAA compliant and have been recommended by the Jupyter a11y community. However, these themes are not compatible with classic notebook interface.</p>
b) Github Light. Both the themes are WCAG 2.1 AAA compliant and have been recommended by the Jupyter a11y community. However, these themes are not compatible with classic notebook interface.</p>
<p><a class="reference external" href="https://github.com/dunovank/jupyter-themes">Jupyter Themes</a> is a notebook theme that offers 7 different types of themes to customize the classic notebook experience. This theme only works with classic notebook interface and is not compatible with JupyterLab and the Notebook 7.0. The different types of themes are onedork, grade3, oceans16, chesterish, monokai, solarizedI, solarizedd. You can explore these themes using the documentation in <a class="reference external" href="https://github.com/dunovank/jupyter-themes">this web page</a>. If you are looking for JupyterLab equivalent for those themes then you can explore JupyterLab <a class="reference external" href="https://github.com/dunovank/jupyterlab_legos_ui">Legos UI</a> and <a class="reference external" href="https://github.com/dunovank/jupyterlab_darkside_ui">Darkside UI</a></p>
</section>
<section id="jupyter-font">
Expand Down

0 comments on commit d4a4dfb

Please sign in to comment.