diff --git a/docs/source/conf.py b/docs/source/conf.py index eb5b39e..2312cc2 100755 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -18,7 +18,7 @@ import sys, os from pathlib import Path -# http://read-the-docs.readthedocs.io/en/latest/faq.html +# https://read-the-docs.readthedocs.io/en/latest/faq.html ON_RTD = os.environ.get('READTHEDOCS', None) == 'True' if ON_RTD: diff --git a/docs/source/config/custommagics.rst b/docs/source/config/custommagics.rst index f4daa9a..99d4068 100644 --- a/docs/source/config/custommagics.rst +++ b/docs/source/config/custommagics.rst @@ -151,7 +151,7 @@ Complete Example Here is a full example of a magic package. You can distribute magics using setuptools, distutils, or any other distribution tools like `flit -`_ for pure Python packages. +`_ for pure Python packages. When distributing magics as part of a package, recommended best practice is to execute the registration inside the `load_ipython_extension` as demonstrated in diff --git a/docs/source/config/integrating.rst b/docs/source/config/integrating.rst index 0a1f0ec..7041de5 100644 --- a/docs/source/config/integrating.rst +++ b/docs/source/config/integrating.rst @@ -103,7 +103,7 @@ Rarely, you might want to display a custom traceback when reporting an exception. To do this, define the custom traceback using `_render_traceback_(self)` method which returns a list of strings, one string for each line of the traceback. For example, the `ipyparallel -`__ a parallel computing framework for +`__ a parallel computing framework for IPython, does this to display errors from multiple engines. Please be conservative in using this feature; by replacing the default traceback diff --git a/docs/source/development/wrapperkernels.rst b/docs/source/development/wrapperkernels.rst index d734c30..a15cf8e 100644 --- a/docs/source/development/wrapperkernels.rst +++ b/docs/source/development/wrapperkernels.rst @@ -7,7 +7,7 @@ You can now re-use the kernel machinery in IPython to easily make new kernels. This is useful for languages that have Python bindings, such as `Octave `_ (via `Oct2Py `_), or languages -where the REPL can be controlled in a tty using `pexpect `_, +where the REPL can be controlled in a tty using `pexpect `_, such as bash. .. seealso:: diff --git a/docs/source/index.rst b/docs/source/index.rst index c627993..9cec057 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -57,7 +57,7 @@ features: The Command line interface inherits the above functionality and adds -* real multi-line editing thanks to `prompt_toolkit `_. +* real multi-line editing thanks to `prompt_toolkit `_. * syntax highlighting as you type. @@ -69,7 +69,7 @@ it allows: * the object to create a rich display of Html, Images, Latex, Sound and Video. -* interactive widgets with the use of the `ipywidgets `_ package. +* interactive widgets with the use of the `ipywidgets `_ package. This documentation will walk you through most of the features of the IPython @@ -102,9 +102,9 @@ repository `_. .. seealso:: - `Jupyter documentation `__ + `Jupyter documentation `__ The Jupyter documentation provides information about the Notebook code and other Jupyter sub-projects. - `ipyparallel documentation `__ + `ipyparallel documentation `__ Formerly ``IPython.parallel``. diff --git a/docs/source/install/index.rst b/docs/source/install/index.rst index 3793fae..41036d8 100644 --- a/docs/source/install/index.rst +++ b/docs/source/install/index.rst @@ -51,7 +51,7 @@ for more help see .. seealso:: - `Installing Jupyter `__ + `Installing Jupyter `__ The Notebook, nbconvert, and many other former pieces of IPython are now part of Project Jupyter. diff --git a/docs/source/interactive/index.rst b/docs/source/interactive/index.rst index 7010c51..6684eb5 100644 --- a/docs/source/interactive/index.rst +++ b/docs/source/interactive/index.rst @@ -29,4 +29,4 @@ done some work in the classic Python REPL. .. seealso:: `A Qt Console for Jupyter `__ - `The Jupyter Notebook `__ + `The Jupyter Notebook `__ diff --git a/docs/source/overview.rst b/docs/source/overview.rst index fa70a2f..2c5920e 100644 --- a/docs/source/overview.rst +++ b/docs/source/overview.rst @@ -219,7 +219,7 @@ different numbers which correspond to the Process ID of the kernel. You can read more about using `jupyter qtconsole `_, and -`jupyter notebook `_. There +`jupyter notebook `_. There is also a :ref:`message spec ` which documents the protocol for communication between kernels and clients. @@ -234,7 +234,7 @@ Interactive parallel computing This functionality is optional and now part of the `ipyparallel -`_ project. +`_ project. Portability and Python requirements ----------------------------------- diff --git a/docs/source/whatsnew/github-stats-1.0.rst b/docs/source/whatsnew/github-stats-1.0.rst index 03622ec..4aeb36e 100644 --- a/docs/source/whatsnew/github-stats-1.0.rst +++ b/docs/source/whatsnew/github-stats-1.0.rst @@ -1099,7 +1099,7 @@ Pull Requests (793): * :ghpull:`2274`: CLN: Use name to id mapping of notebooks instead of searching. * :ghpull:`2270`: SSHLauncher tweaks * :ghpull:`2269`: add missing location when disambiguating controller IP -* :ghpull:`2263`: Allow docs to build on http://readthedocs.io/ +* :ghpull:`2263`: Allow docs to build on https://readthedocs.io/ * :ghpull:`2256`: Adding data publication example notebook. * :ghpull:`2255`: better flush iopub with AsyncResults * :ghpull:`2261`: Fix: longest_substr([]) -> '' diff --git a/docs/source/whatsnew/version5.rst b/docs/source/whatsnew/version5.rst index 62aea16..61b6ca0 100644 --- a/docs/source/whatsnew/version5.rst +++ b/docs/source/whatsnew/version5.rst @@ -307,7 +307,7 @@ and tab completions that don't clutter up your history. :target: ../_images/ptshell_features.png These features are provided by the Python library `prompt_toolkit -`__, which replaces +`__, which replaces ``readline`` throughout our terminal interface. Relying on this pure-Python, cross platform module also makes it simpler to