Merge pull request #531 from choldgraf/myst

📚 DOCS: updating a page to myst

docs/doc-requirements.txt

@@ -1,6 +1,6 @@
 sphinx>=3.1
 sphinx-intl
-recommonmark
+myst_parser
 nbsphinx
 pydata-sphinx-theme
 sphinx-panels

docs/source/conf.py

@@ -9,7 +9,6 @@
 import sys
 import os
 import shlex
-import recommonmark.parser
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -30,7 +29,7 @@
     'sphinx.ext.doctest',
     'sphinx.ext.intersphinx',
     'sphinx.ext.graphviz', # Add the graphviz extension
-    'recommonmark',
+    'myst_parser',
     'sphinx_panels'
 ]
 

docs/source/index.md

@@ -0,0 +1,190 @@
+# 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
+
+```{list-table}
+:class: front_page_table
+
+* - {doc}`Get started with Jupyter Notebook <content-quickstart>`
+
+      Try the notebook
+
+   - {doc}`Community <community/content-community>`
+
+      Sustainability and growth
+
+* - {doc}`Architecture <projects/architecture/content-architecture>`
+
+      What is Jupyter?
+
+   - {doc}`Contributor Guides <contributing/content-contributor>`
+
+      How to contribute to the projects
+
+* - {doc}`Narratives and Use Cases <use/use-cases/content-user>`
+
+      Narratives of common deployment scenarios
+
+   - {doc}`Release Notes <releases>`
+
+      New features, upgrades, deprecation notes, and bug fixes
+
+* - {doc}`IPython <reference/ipython>`
+
+      An interactive Python kernel and REPL
+
+   - {doc}`Reference <reference/content-reference>`
+
+      APIs
+
+* - {doc}`Installation, Configuration, and Usage <projects/content-projects>`
+
+      Documentation for users
+
+   - {doc}`Advanced <use/advanced/content-advanced>`
+
+      Documentation for advanced use-cases
+```
+
+## Sub-project documentation
+
+```{panels}
+Jupyter User Interfaces
+^^^^^^
+* [Jupyter Notebook](http://jupyter-notebook.readthedocs.io/en/latest/)
+* [Jupyter console](http://jupyter_console.readthedocs.io/en/latest)
+* [Qt console](https://qtconsole.readthedocs.io/en/stable)
+
+---
+JupyterHub
+^^^^^^
+* [JupyterHub](http://jupyterhub.readthedocs.io/en/latest)
+* [configurable HTTP proxy](https://github.com/jupyter/configurable-http-proxy)
+* [dockerspawner](https://github.com/jupyter/dockerspawner)
+* [ldapauthenticator](https://github.com/jupyter/ldapauthenticator)
+* [oauthenticator](https://github.com/jupyter/oauthenticator)
+* [sudospawner](https://github.com/jupyter/sudospawner)
+
+---
+Education
+^^^^^^
+* [nbgrader](http://nbgrader.readthedocs.io/en/latest)
+
+---
+Conversion and Formatting
+^^^^^^
+* [nbconvert](http://nbconvert.readthedocs.io/en/latest)
+* [nbformat](http://nbformat.readthedocs.io/en/latest)
+
+---
+Kernels
+^^^^^^
+* [IPython](https://ipython.readthedocs.io/en/stable>)
+* [IRkernel](https://irkernel.github.io)
+* [IJulia](https://github.com/JuliaLang/IJulia.jl)
+* [Community maintained kernels](https://github.com/ipython/ipython/wiki/IPython-kernels-for-other-languages)
+
+---
+IPython
+^^^^^^
+* [IPython](http://ipython.readthedocs.io/en/stable>)
+* [ipykernel](https://ipython.readthedocs.io/en/stable)
+* [ipyparallel](https://ipyparallel.readthedocs.io/en/latest)
+
+---
+Architecture
+^^^^^^
+* [jupyter_client](http://jupyter-client.readthedocs.io/en/latest)
+* [jupyter_core](http://jupyter-core.readthedocs.io/en/latest)
+
+---
+Deployment
+^^^^^^
+* [docker-stacks](https://github.com/jupyter/docker-stacks)
+* [jupyter-sphinx-theme](https://github.com/jupyter/jupyter-sphinx-theme)
+* [kernel_gateway](http://jupyter-kernel-gateway.readthedocs.io/en/latest)
+* [nbviewer](https://github.com/jupyter/nbviewer)
+* [tmpnb](https://github.com/jupyter/tmpnb)
+* [traitlets](http://traitlets.readthedocs.io/en/stable)
+
+---
+JupyterLab
+^^^^^^
+* [JupyterLab](https://github.com/jupyterlab/jupyterlab)
+* [ipywidgets](https://ipywidgets.readthedocs.io/en/latest)
+
+```
+
+## Table of Contents
+
+(user-docs)=
+
+```{toctree}
+:maxdepth: 2
+
+content-quickstart
+```
+
+(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/help repo](https://github.com/jupyter/help), Start here for help and support questions
+[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](http://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`