From 87c8b1af3cf630fbdbfe0338dbccf8f708917f6d Mon Sep 17 00:00:00 2001 From: Thomas Kluyver Date: Sun, 9 Oct 2016 22:10:05 +0100 Subject: [PATCH] Backport PR #1822: Convert readthedocs links for their .org -> .io migration for hosted projects MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit As per [their blog post of the 27th April](https://blog.readthedocs.com/securing-subdomains/) ‘Securing subdomains’: > Starting today, Read the Docs will start hosting projects from subdomains on the domain readthedocs.io, instead of on readthedocs.org. This change addresses some security concerns around site cookies while hosting user generated data on the same domain as our dashboard. Test Plan: Manually visited all the links I’ve modified. Signed-off-by: Min RK --- README.md | 10 +++++----- docs/source/conf.py | 6 +++--- ...ibuting Jupyter Extensions as Python Packages.ipynb | 4 ++-- docs/source/extending/contents.rst | 2 +- docs/source/index.rst | 6 +++--- docs/source/links.txt | 2 +- setup.py | 2 +- 7 files changed, 16 insertions(+), 16 deletions(-) diff --git a/README.md b/README.md index c8cbd11a6..6342622d1 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.io/projects/jupyter-notebook/badge/?version=latest)](http://jupyter-notebook.readthedocs.org/en/latest/?badge=latest) +[![Documentation Status](https://readthedocs.org/projects/jupyter-notebook/badge/?version=latest)](https://jupyter-notebook.readthedocs.io/en/latest/?badge=latest) The Jupyter notebook is a web-based notebook environment for interactive computing. @@ -24,9 +24,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: @@ -122,7 +122,7 @@ jupyter notebook ## 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 d32d0daac..a5f9f21f3 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -328,7 +328,7 @@ 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), } 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 d14cb4f50..2032ae896 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 @@ -120,11 +120,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 9271d8ecd..e997f05f8 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 e728359af..8b14bb4d6 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 comms 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 9cd515ab6..26d80ceb8 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,