diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index eb75254e6..22adc4a9a 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -14,7 +14,7 @@ General Guidelines For general documentation about contributing to Jupyter projects, see the `Project Jupyter Contributor Documentation`__. -__ http://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html +__ https://jupyter.readthedocs.io/en/latest/contributor/content-contributor.html Setting Up a Development Environment diff --git a/README.md b/README.md index 4cb636b2b..c0fb57c1d 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![Google Group](https://img.shields.io/badge/-Google%20Group-lightgrey.svg)](https://groups.google.com/forum/#!forum/jupyter) [![Build Status](https://travis-ci.org/jupyter/notebook.svg?branch=master)](https://travis-ci.org/jupyter/notebook) -[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](http://jupyter-notebook.readthedocs.io/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest) @@ -26,9 +26,9 @@ discrete repos. ## Installation You can find the installation documentation for the -[Jupyter platform, on ReadTheDocs](http://jupyter.readthedocs.io/en/latest/install.html). +[Jupyter platform, on ReadTheDocs](https://jupyter.readthedocs.io/en/latest/install.html). The documentation for advanced usage of Jupyter notebook can be found -[here](http://jupyter-notebook.readthedocs.io/en/latest). +[here](https://jupyter-notebook.readthedocs.io/en/latest/). For a local installation, make sure you have [pip installed](https://pip.readthedocs.io/en/stable/installing/) and run: @@ -54,7 +54,7 @@ If you are interested in contributing to the project, see [`CONTRIBUTING.rst`](C ## Resources - [Project Jupyter website](https://jupyter.org) - [Online Demo at try.jupyter.org](https://try.jupyter.org) -- [Documentation for Jupyter notebook](http://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.io/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)] -- [Documentation for Project Jupyter](http://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.io/pdf/jupyter/latest/jupyter.pdf)] +- [Documentation for Jupyter notebook](https://jupyter-notebook.readthedocs.io/en/latest/) [[PDF](https://media.readthedocs.org/pdf/jupyter-notebook/latest/jupyter-notebook.pdf)] +- [Documentation for Project Jupyter](https://jupyter.readthedocs.io/en/latest/index.html) [[PDF](https://media.readthedocs.org/pdf/jupyter/latest/jupyter.pdf)] - [Issues](https://github.com/jupyter/notebook/issues) - [Technical support - Jupyter Google Group](https://groups.google.com/forum/#!forum/jupyter) diff --git a/docs/source/conf.py b/docs/source/conf.py index 6d50a9618..0c0d5644a 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -332,9 +332,9 @@ texinfo_documents = [ intersphinx_mapping = { 'ipython': ('http://ipython.org/ipython-doc/dev/', None), - 'nbconvert': ('http://nbconvert.readthedocs.org/en/latest/', None), - 'nbformat': ('http://nbformat.readthedocs.org/en/latest/', None), - 'jupyter': ('http://jupyter.readthedocs.org/en/latest/', None), + 'nbconvert': ('https://nbconvert.readthedocs.io/en/latest/', None), + 'nbformat': ('https://nbformat.readthedocs.io/en/latest/', None), + 'jupyter': ('https://jupyter.readthedocs.io/en/latest/', None), } spelling_lang='en_US' diff --git a/docs/source/config_overview.rst b/docs/source/config_overview.rst index 5a346b7d5..3fcc51e7a 100644 --- a/docs/source/config_overview.rst +++ b/docs/source/config_overview.rst @@ -25,7 +25,7 @@ and editing settings is similar for all the Jupyter applications. - `Jupyter’s Common Configuration Approach `_ - `Common Directories and File Locations `_ - `Language kernels `_ - - `traitlets `_ + - `traitlets `_ provide a low-level architecture for configuration. .. _configure_nbserver: @@ -47,7 +47,7 @@ front-end Notebook client (i.e. the familiar notebook interface). documented in the configuration file and the user documentation. - :ref:`Running a Notebook server ` - - Related: `Configuring a language kernel `_ + - Related: `Configuring a language kernel `_ to run in the Notebook server enables your server to run other languages, like R or Julia. .. _configure_nbclient: @@ -65,8 +65,8 @@ Notebook front-end client Notebook extensions ------------------- -- `Distributing Jupyter Extensions as Python Packages `_ -- `Extending the Notebook `_ +- `Distributing Jupyter Extensions as Python Packages `_ +- `Extending the Notebook `_ :ref:`Security in Jupyter notebooks: ` Since security diff --git a/docs/source/examples/Notebook/Distributing Jupyter Extensions as Python Packages.ipynb b/docs/source/examples/Notebook/Distributing Jupyter Extensions as Python Packages.ipynb index e3f8bead0..aaedd7365 100644 --- a/docs/source/examples/Notebook/Distributing Jupyter Extensions as Python Packages.ipynb +++ b/docs/source/examples/Notebook/Distributing Jupyter Extensions as Python Packages.ipynb @@ -123,11 +123,11 @@ "## Additional resources on creating and distributing packages \n", "\n", "> Of course, in addition to the files listed, there are number of other files one needs to build a proper package. Here are some good resources:\n", - "- [The Hitchhiker's Guide to Packaging](http://the-hitchhikers-guide-to-packaging.readthedocs.org/en/latest/quickstart.html)\n", + "- [The Hitchhiker's Guide to Packaging](https://the-hitchhikers-guide-to-packaging.readthedocs.io/en/latest/quickstart.html)\n", "- [Repository Structure and Python](http://www.kennethreitz.org/essays/repository-structure-and-python) by Kenneth Reitz\n", "\n", "> How you distribute them, too, is important:\n", - "- [Packaging and Distributing Projects](http://python-packaging-user-guide.readthedocs.org/en/latest/distributing/)\n", + "- [Packaging and Distributing Projects](https://python-packaging-user-guide.readthedocs.io/distributing/)\n", "- [conda: Building packages](http://conda.pydata.org/docs/building/build.html)\n", "\n", "> Here are some tools to get you started:\n", diff --git a/docs/source/extending/contents.rst b/docs/source/extending/contents.rst index 4c116706d..952760aa6 100644 --- a/docs/source/extending/contents.rst +++ b/docs/source/extending/contents.rst @@ -214,6 +214,6 @@ ContentsManager. directories as SQL relations. PGContents also provides an example of how to re-use the notebook's tests. -.. _NBFormat: http://nbformat.readthedocs.org/en/latest/index.html +.. _NBFormat: https://nbformat.readthedocs.io/en/latest/index.html .. _PGContents: https://github.com/quantopian/pgcontents .. _PostgreSQL: http://www.postgresql.org/ diff --git a/docs/source/index.rst b/docs/source/index.rst index 3c88b972b..ae1cbd6c0 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -7,9 +7,9 @@ The Jupyter notebook :caption: User Documentation notebook - Installation - Running the Notebook - Migrating from IPython + Installation + Running the Notebook + Migrating from IPython ui_components .. toctree:: diff --git a/docs/source/links.txt b/docs/source/links.txt index 34192d75b..c926fece8 100644 --- a/docs/source/links.txt +++ b/docs/source/links.txt @@ -27,7 +27,7 @@ .. Other python projects .. _matplotlib: http://matplotlib.org .. _nbviewer: http://nbviewer.jupyter.org -.. _nbconvert: http://nbconvert.readthedocs.org/en/latest/ +.. _nbconvert: https://nbconvert.readthedocs.io/en/latest/ .. Other tools and projects .. _Markdown: http://daringfireball.net/projects/markdown/syntax diff --git a/setup.py b/setup.py index eed63efa9..151918633 100755 --- a/setup.py +++ b/setup.py @@ -72,7 +72,7 @@ share documents that contain live code, equations, visualizations, and explanatory text. The Notebook has support for multiple programming languages, sharing, and interactive widgets. -Read `the documentation `_ +Read `the documentation `_ for more information. """, version = version,