Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 36 additions & 42 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,50 +1,34 @@
.. _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 <https://blog.jupyter.org/2016/01/08/notebook-4-1-release/>`_
Welcome to **Project Jupyter's "official" documentation landing page**. From
this page, you may access all "official" documentation for Project Jupyter and
IPython projects.

- 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
**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.

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 <https://nbviewer.jupyter.org/>`__.

The main documentation for Jupyter users is organized into several sections:

- :ref:`User Documentation<user-docs>`
- :ref:`Jupyter Subprojects<jupyter-subprojects>`
- :ref:`About Jupyter<about-docs>`

:ref:`Contributor Documentation<dev-docs>` 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
Expand All @@ -56,17 +40,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
Expand All @@ -78,11 +75,8 @@ newsletter.
contrib_guide_newsletter


.. _about-docs:

.. toctree::
:maxdepth: 2
:caption: About Jupyter

data_science
Links to project documentation
------------------------------

Links to support and help
-------------------------
4 changes: 2 additions & 2 deletions docs/source/running.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down
6 changes: 3 additions & 3 deletions docs/source/subprojects.rst
Original file line number Diff line number Diff line change
@@ -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
Expand Down