# Jupyter Project Documentation **Welcome to the Jupyter Project documentation**. This website acts as "meta" documentation for the Jupyter ecosystem. It has a collection of resources to navigate the tools and communities in this ecosystem, and to help you get started. ## Start Here These are a few high-level topics to help you learn more about the Jupyter community and ecosystem. ```{list-table} :class: front_page_table * - {doc}`Get started with Jupyter Notebook ` Try the notebook - {doc}`Community ` Sustainability and growth * - {doc}`Architecture ` What is Jupyter? - {doc}`Contributor Guides ` How to contribute to the projects * - {doc}`Narratives and Use Cases ` Narratives of common deployment scenarios - {doc}`Release Notes ` New features, upgrades, deprecation notes, and bug fixes * - {doc}`IPython ` An interactive Python kernel and REPL - {doc}`Reference ` APIs * - {doc}`Installation, Configuration, and Usage ` Documentation for users - {doc}`Advanced ` Documentation for advanced use-cases ``` ## Sub-project documentation Sub-projects are major technical and community efforts, and generally have their own documentation for their communities. Below is a list of documentation for major parts of the Jupyter ecosystem. ```{panels} User Interfaces ^^^^^^ * [JupyterLab](https://github.com/jupyterlab/jupyterlab) * [Jupyter Notebook](https://jupyter-notebook.readthedocs.io/en/latest/) * [nbclassic](https://github.com/jupyterlab/nbclassic) * [Jupyter Console](https://jupyter_console.readthedocs.io/en/latest) * [Qt console](https://qtconsole.readthedocs.io/en/stable) * [Voilà](https://voila.readthedocs.io/) --- JupyterHub ^^^^^^ * [JupyterHub](https://jupyterhub.readthedocs.io/en/latest) * [Configurable HTTP proxy](https://github.com/jupyterhub/configurable-http-proxy) * Authenticators: [LDAP](https://github.com/jupyterhub/ldapauthenticator), [OAuth](https://oauthenticator.readthedocs.io/en/latest/), [Native](https://native-authenticator.readthedocs.io/en/latest/), [LTI](https://ltiauthenticator.readthedocs.io/en/latest/) * Spawners: [sudo](https://github.com/jupyterhub/sudospawner), [Docker](https://jupyterhub-dockerspawner.readthedocs.io/en/latest/), [Kubernetes](https://jupyterhub-kubespawner.readthedocs.io/en/latest/) * [Zero to JupyterHub](https://zero-to-jupyterhub.readthedocs.io/en/latest/) * [All JupyterHub Projects...](https://github.com/jupyterhub) --- Working with Notebooks ^^^^^^ * [nbclient](https://nbclient.readthedocs.io/en/latest/) - execution * [nbconvert](https://nbconvert.readthedocs.io/en/latest/) - conversion * [nbviewer](https://github.com/jupyter/nbviewer/) - viewing * [nbdime](https://nbdime.readthedocs.io/) - comparing and merging * [nbgrader](https://nbgrader.readthedocs.io/en/latest/) - grading * [nbformat](https://nbformat.readthedocs.io/en/latest/) - modification and validation --- Kernels ^^^^^^ * [IPython](https://ipython.readthedocs.io/en/stable/) * [IRkernel](https://irkernel.github.io) * [IJulia](https://github.com/JuliaLang/IJulia.jl) * [Xeus kernels](https://xeus.readthedocs.io/en/latest/) * [Community maintained kernels](https://github.com/jupyter/jupyter/wiki/Jupyter-kernels) --- IPython ^^^^^^ * [IPython](https://ipython.readthedocs.io/en/stable/) * [ipykernel](https://ipython.readthedocs.io/en/stable/) * [ipyparallel](https://ipyparallel.readthedocs.io/en/latest/) * [traitlets](https://traitlets.readthedocs.io/en/stable/) --- Architecture and Specification ^^^^^^ * [nbformat](https://nbformat.readthedocs.io/en/latest/api.html) - Jupyter Notebook Format * [jupyter-client](https://jupyter-client.readthedocs.io/en/latest/) - Jupyter Messaging Protocol * [jupyter-core](https://jupyter-core.readthedocs.io/en/latest/) * [jupyter-server](https://jupyter-server.readthedocs.io/) * [jupyterlab-server](https://jupyterlab-server.readthedocs.io/en/stable/) --- Deployment ^^^^^^ * [Docker Stacks](https://jupyter-docker-stacks.readthedocs.io/en/latest/) * [Kernel Gateway](https://jupyter-kernel-gateway.readthedocs.io/en/latest/) * [Enterprise Gateway](https://jupyter-enterprise-gateway.readthedocs.io/en/latest/) --- Widgets ^^^^^^ * [ipywidgets](https://ipywidgets.readthedocs.io/) * [widget-cookiecutter](https://github.com/jupyter-widgets/widget-cookiecutter/) * [All Widget Projects...](https://github.com/jupyter-widgets) ``` ## Table of Contents The rest of the documentation on this site covers major use-cases of the Jupyter ecosystem, as well as topics that will help you navigate the various parts of the Jupyter community. For more in-depth documentation about a specific tool, we recommend checking out that tool's documentation (see the list above). (user-docs)= ```{toctree} :maxdepth: 2 start/index ``` (jupyter-using)= ```{toctree} :maxdepth: 2 use/using ``` (jupyter-subprojects)= ```{toctree} :maxdepth: 2 projects/content-projects ``` ```{toctree} :maxdepth: 2 community/content-community ``` (dev-docs)= ```{toctree} :maxdepth: 2 contributing/content-contributor ``` ```{toctree} :maxdepth: 2 reference/content-reference ``` ## Resources ```{csv-table} :header: Site, Description :widths: 18, 35 [Jupyter website](https://jupyter.org), Keep up to date on Jupyter [IPython website](https://ipython.org), Learn more about IPython [Jupyter Discourse forum](https://discourse.jupyter.org/), Start here for help and support questions [Jupyter Accessibility](https://jupyter-accessibility.readthedocs.io/), Accessibility sub-project documentation [Jupyter mailing list](https://groups.google.com/forum/#!forum/jupyter), General discussion of Jupyter's use [Jupyter in Education group](https://groups.google.com/forum/#!forum/jupyter-education), Discussion of Jupyter's use in education [NumFocus](https://www.numfocus.org), "Promotes world-class, innovative, open source scientific software" [Donate to Project Jupyter](https://numfocus.salsalabs.org/donate-to-jupyter/index.html), Please contribute to open science collaboration and sustainability ``` ## Indices and tables - {ref}`genindex` - {ref}`glossary` - {ref}`search`