From a1663ffea14ae4101a010c02538a8fd1eab61ce4 Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sat, 2 Apr 2016 11:16:14 -0700 Subject: [PATCH 1/2] Revise landing page --- docs/source/index.rst | 73 +++++++++++++------------------------ docs/source/running.rst | 4 +- docs/source/subprojects.rst | 6 +-- 3 files changed, 31 insertions(+), 52 deletions(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index e71319b..38ece49 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -1,50 +1,26 @@ .. _landing: -===================== -Jupyter Documentation -===================== +=============== +Project Jupyter +=============== -The Jupyter Notebook is a web application for interactive data science and -scientific computing. - -.. sidebar:: What's New in Jupyter Notebook - **Release 4.1** `Announcement `_ - - - Cell toolbar selector moved to View menu - - Restart & Run All Cells added to Kernel menu - - Multiple-cell selection and actions including cut, copy, paste and execute - - Command palette added for executing Jupyter actions - - Find and replace added to Edit menu +Welcome to Project Jupyter's documentation hosted on Read the Docs. - To upgrade to the release: - ``pip install notebook --upgrade`` - or - ``conda upgrade notebook`` - -Using the Jupyter Notebook, you can author engaging +Jupyter Notebook Quickstart +--------------------------- +The Jupyter Notebook is a web application for interactive data science and +scientific computing. Using the Jupyter Notebook, you can author engaging documents that combine live-code with narrative text, equations, images, video, and visualizations. By encoding a complete and reproducible record of a computation, the documents can be shared with others on GitHub, Dropbox, and the `Jupyter Notebook Viewer `__. -The main documentation for Jupyter users is organized into several sections: - - - :ref:`User Documentation` - - :ref:`Jupyter Subprojects` - - :ref:`About Jupyter` - -:ref:`Contributor Documentation` covers how to help with the -development of Jupyter as well as technical details helpful for development. It -also covers how to contribute to our documentation, blog, website, and -newsletter. - - .. _user-docs: .. toctree:: - :maxdepth: 2 - :caption: User Documentation + :maxdepth: 1 + :caption: Notebook Quickstart tryjupyter install @@ -56,17 +32,30 @@ newsletter. .. _jupyter-subprojects: .. toctree:: - :maxdepth: 2 - :caption: Jupyter Subprojects + :maxdepth: 1 + :caption: Projects subprojects + incubator + kernels + jupyter_enhancement_proposals config +.. _about-docs: + +.. toctree:: + :maxdepth: 1 + :caption: User Stories + + data_science + science + education + hpc .. _dev-docs: .. toctree:: - :maxdepth: 2 + :maxdepth: 1 :caption: Contributor Documentation contrib_guide_welcome @@ -76,13 +65,3 @@ newsletter. contrib_guide_site contrib_guide_blog contrib_guide_newsletter - - -.. _about-docs: - -.. toctree:: - :maxdepth: 2 - :caption: About Jupyter - - data_science - diff --git a/docs/source/running.rst b/docs/source/running.rst index 43f7a31..0790d69 100644 --- a/docs/source/running.rst +++ b/docs/source/running.rst @@ -15,9 +15,9 @@ It will then open your default web browser to this URL. When the notebook opens, you will see the notebook dashboard, which will show a list of the notebooks, files, and subdirectories in the directory where the notebook server was started (as seen in the next section, below). Most of the time, you will want to start a notebook server in the highest directory in your filesystem where notebooks can be found. Often this will be your home directory. -==================== + Additional options -==================== +------------------ By default, the notebook server starts on port 8888. If port 8888 is unavailable, the notebook server searches the next available port. You can also specify the port manually:: diff --git a/docs/source/subprojects.rst b/docs/source/subprojects.rst index 29244b8..30decab 100644 --- a/docs/source/subprojects.rst +++ b/docs/source/subprojects.rst @@ -1,9 +1,9 @@ .. _subprojects: -=================== -Jupyter subprojects -=================== +======== +Projects +======== Project Jupyter is developed as a set of subprojects. The following is a topical list of the officially supported and maintained subprojects with links to the From 6cfb657961cb902411daba5414adfe8158bede6b Mon Sep 17 00:00:00 2001 From: Carol Willing Date: Sun, 3 Apr 2016 04:24:01 -0700 Subject: [PATCH 2/2] Add intro to README --- docs/source/index.rst | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/docs/source/index.rst b/docs/source/index.rst index 38ece49..c60bcec 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -5,7 +5,15 @@ Project Jupyter =============== -Welcome to Project Jupyter's documentation hosted on Read the Docs. +Welcome to **Project Jupyter's "official" documentation landing page**. From +this page, you may access all "official" documentation for Project Jupyter and +IPython projects. + +**What is Project Jupyter?** Project Jupyter was born out of the IPython +Project in 2014 as the project evolved to support interactive data science +and scientific computing across all programming languages. The popular +Jupyter Notebook (formerly IPython notebook) is a cornerstone of the project. + Jupyter Notebook Quickstart --------------------------- @@ -65,3 +73,10 @@ the `Jupyter Notebook Viewer `__. contrib_guide_site contrib_guide_blog contrib_guide_newsletter + + +Links to project documentation +------------------------------ + +Links to support and help +-------------------------