Skip to content

Commit dc8ae35

Browse files
committed
DOC: Fix a few links, use https
1 parent 40bb8fb commit dc8ae35

File tree

10 files changed

+30
-30
lines changed

10 files changed

+30
-30
lines changed

README.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ Source code repository (and issue tracker):
2727
License:
2828
MIT -- see the file ``LICENSE`` for details.
2929

30-
.. _Sphinx: http://sphinx-doc.org/
31-
.. _Jupyter Notebook: http://jupyter.org/
30+
.. _Sphinx: https://www.sphinx-doc.org/
31+
.. _Jupyter Notebook: https://jupyter.org/

doc/a-normal-rst-file.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Links to Notebooks (and Other Sphinx Source Files)
1111
Links to Sphinx source files can be created like normal `Sphinx hyperlinks`_,
1212
just using a relative path to the local file: link_.
1313

14-
.. _Sphinx hyperlinks: http://www.sphinx-doc.org/en/master/usage/
14+
.. _Sphinx hyperlinks: https://www.sphinx-doc.org/en/master/usage/
1515
restructuredtext/basics.html#external-links
1616
.. _link: subdir/a-notebook-in-a-subdir.ipynb
1717

@@ -80,7 +80,7 @@ Links to Notebooks, Ye Olde Way
8080

8181
In addition to the way shown above, you can also create links to notebooks (and
8282
other Sphinx source files) with
83-
`:ref: <http://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref>`_.
83+
`:ref: <https://www.sphinx-doc.org/en/master/usage/restructuredtext/roles.html#role-ref>`_.
8484
This has some disadvantages:
8585

8686
* It is arguably a bit more clunky.

doc/code-cells.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -237,7 +237,7 @@
237237
"metadata": {},
238238
"outputs": [],
239239
"source": [
240-
"Image(url='http://jupyter.org/assets/nav_logo.svg')"
240+
"Image(url='https://jupyter.org/assets/nav_logo.svg')"
241241
]
242242
},
243243
{
@@ -325,7 +325,7 @@
325325
"you should also have a look at the `'svg.hashsalt'` setting.\n",
326326
"\n",
327327
"For more details on these and other settings, have a look at\n",
328-
"[Default Values for Matplotlib's \"inline\" Backend](http://nbviewer.jupyter.org/github/mgeier/python-audio/blob/master/plotting/matplotlib-inline-defaults.ipynb).\n",
328+
"[Default Values for Matplotlib's \"inline\" Backend](https://nbviewer.jupyter.org/github/mgeier/python-audio/blob/master/plotting/matplotlib-inline-defaults.ipynb).\n",
329329
"\n",
330330
"The configuration file `ipython_kernel_config.py` can be either\n",
331331
"in the directory where your notebook is located\n",
@@ -435,7 +435,7 @@
435435
"source": [
436436
"### Pandas Dataframes\n",
437437
"\n",
438-
"[Pandas dataframes](http://pandas.pydata.org/pandas-docs/stable/dsintro.html#dataframe)\n",
438+
"[Pandas dataframes](http://pandas.pydata.org/pandas-docs/stable/getting_started/dsintro.html#dataframe)\n",
439439
"should be displayed as nicely formatted HTML tables (if you are using HTML output)."
440440
]
441441
},
@@ -485,7 +485,7 @@
485485
"This is not enabled by default because of\n",
486486
"[Pandas issue #12182](https://github.com/pandas-dev/pandas/issues/12182).\n",
487487
"\n",
488-
"The generated LaTeX tables utilize the `booktabs` package, so you have to make sure that package is [loaded in the preamble](http://www.sphinx-doc.org/en/master/latex.html) with:\n",
488+
"The generated LaTeX tables utilize the `booktabs` package, so you have to make sure that package is [loaded in the preamble](https://www.sphinx-doc.org/en/master/latex.html) with:\n",
489489
"\n",
490490
" \\usepackage{booktabs}\n",
491491
"\n",

doc/installation.ipynb

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
"\n",
2424
"[![Anaconda Badge](https://anaconda.org/conda-forge/nbsphinx/badges/version.svg)](https://anaconda.org/conda-forge/nbsphinx)\n",
2525
"\n",
26-
"If you are using the `conda` package manager (e.g. with [Anaconda](https://www.anaconda.com/download/) for Linux/macOS/Windows), you can install `nbsphinx` from the [conda-forge](https://conda-forge.org/) channel:\n",
26+
"If you are using the `conda` package manager (e.g. with [Anaconda](https://www.anaconda.com/distribution/) for Linux/macOS/Windows), you can install `nbsphinx` from the [conda-forge](https://conda-forge.org/) channel:\n",
2727
"\n",
2828
" conda install -c conda-forge nbsphinx\n",
2929
"\n",
@@ -62,11 +62,11 @@
6262
"\n",
6363
"Of course you'll need Python, because both Sphinx and `nbsphinx` are implemented in Python.\n",
6464
"There are many ways to get Python.\n",
65-
"If you don't know which one is best for you, you can try [Anaconda](https://www.anaconda.com/download/).\n",
65+
"If you don't know which one is best for you, you can try [Anaconda](https://www.anaconda.com/distribution/).\n",
6666
"\n",
6767
"### Sphinx\n",
6868
"\n",
69-
"You'll need [Sphinx](http://www.sphinx-doc.org/) as well, because `nbsphinx` is just a Sphinx extension and doesn't do anything on its own.\n",
69+
"You'll need [Sphinx](https://www.sphinx-doc.org/) as well, because `nbsphinx` is just a Sphinx extension and doesn't do anything on its own.\n",
7070
"\n",
7171
"If you use `conda`, you can get [Sphinx from the conda-forge channel](https://anaconda.org/conda-forge/sphinx):\n",
7272
"\n",

doc/markdown-cells.ipynb

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,8 @@
9191
"but you can install a notebook extension in order to enable equation numbering:\n",
9292
"https://jupyter-contrib-nbextensions.readthedocs.io/en/latest/nbextensions/equation-numbering/readme.html.\n",
9393
"\n",
94-
"Automatic Equation Numbering is enabled on http://nbviewer.jupyter.org/,\n",
95-
"see e.g. the latest version of this very notebook at the link http://nbviewer.jupyter.org/github/spatialaudio/nbsphinx/blob/master/doc/markdown-cells.ipynb.\n",
94+
"Automatic Equation Numbering is enabled on https://nbviewer.jupyter.org/,\n",
95+
"see e.g. the latest version of this very notebook at the link https://nbviewer.jupyter.org/github/spatialaudio/nbsphinx/blob/master/doc/markdown-cells.ipynb.\n",
9696
"\n",
9797
"When using `nbsphinx`, you can use the following `mathjax_config` setting in your `conf.py` file\n",
9898
"to enable automatic equation numbering in HTML output.\n",
@@ -236,7 +236,7 @@
236236
"\n",
237237
"* `'sphinx.ext.imgconverter'`:\n",
238238
" This is a built-in Sphinx extension, see\n",
239-
" http://www.sphinx-doc.org/en/master/usage/extensions/imgconverter.html.\n",
239+
" https://www.sphinx-doc.org/en/master/usage/extensions/imgconverter.html.\n",
240240
" \n",
241241
" This needs the external program `convert` from *ImageMagick*.\n",
242242
"\n",
@@ -410,7 +410,7 @@
410410
"source": [
411411
"## Links to `*.rst` Files (and Other Sphinx Source Files)\n",
412412
"\n",
413-
"Links to files whose extension is in the configuration value [source_suffix](http://www.sphinx-doc.org/en/master/config.html#confval-source_suffix), will be converted to links to the generated HTML/LaTeX pages. Example: [A reStructuredText file](a-normal-rst-file.rst).\n",
413+
"Links to files whose extension is in the configuration value [source_suffix](https://www.sphinx-doc.org/en/master/config.html#confval-source_suffix), will be converted to links to the generated HTML/LaTeX pages. Example: [A reStructuredText file](a-normal-rst-file.rst).\n",
414414
"\n",
415415
"This was created with:\n",
416416
"\n",
@@ -462,7 +462,7 @@
462462
"source": [
463463
"## Links to Domain Objects\n",
464464
"\n",
465-
"Links to [Sphinx domain objects](http://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html) (such as a Python class or JavaScript function) are also possible. For example:\n",
465+
"Links to [Sphinx domain objects](https://www.sphinx-doc.org/en/master/usage/restructuredtext/domains.html) (such as a Python class or JavaScript function) are also possible. For example:\n",
466466
"[example_python_function()](a-normal-rst-file.rst#example_python_function).\n",
467467
"\n",
468468
"This was created with:\n",
@@ -471,7 +471,7 @@
471471
"[example_python_function()](a-normal-rst-file.rst#example_python_function)\n",
472472
"```\n",
473473
"\n",
474-
"This is especially useful for use with the Sphinx [autodoc](http://www.sphinx-doc.org/en/master/ext/autodoc.html) extension!"
474+
"This is especially useful for use with the Sphinx [autodoc](https://www.sphinx-doc.org/en/master/ext/autodoc.html) extension!"
475475
]
476476
}
477477
],

doc/orphan.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"source": [
1616
"# An Orphan Notebook (HTML Only)\n",
1717
"\n",
18-
"This means that it doesn't appear in a [toctree](http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree) (see `index.rst`), but other pages can still link to it ...\n",
18+
"This means that it doesn't appear in a [toctree](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree) (see `index.rst`), but other pages can still link to it ...\n",
1919
"\n",
2020
"* ... from a [Markdown cell of another notebook](markdown-cells.ipynb#Links-to-Other-Notebooks) using\n",
2121
"\n",

doc/prolog-and-epilog.ipynb

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -18,12 +18,12 @@
1818
"When including notebooks in your Sphinx documentation, you can choose to add some generic content before and after each notebook.\n",
1919
"This can be done with the configuration values `nbsphinx_prolog` and `nbsphinx_epilog` in the file `conf.py`.\n",
2020
"\n",
21-
"The prolog and epilog strings can hold arbitrary [reST](http://sphinx-doc.org/rest.html) markup.\n",
22-
"Particularly, the [only](http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-only) and [raw](https://docutils.readthedocs.io/en/sphinx-docs/ref/rst/directives.html#raw-data-pass-through) directives can be used to have different content for HTML and LaTeX output.\n",
21+
"The prolog and epilog strings can hold arbitrary [reST](https://www.sphinx-doc.org/rest.html) markup.\n",
22+
"Particularly, the [only](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-only) and [raw](https://docutils.readthedocs.io/en/sphinx-docs/ref/rst/directives.html#raw-data-pass-through) directives can be used to have different content for HTML and LaTeX output.\n",
2323
"\n",
2424
"Those strings are also processed by the [Jinja2](http://jinja.pocoo.org/) templating engine.\n",
2525
"This means you can run Python-like code within those strings.\n",
26-
"You have access to the current [Sphinx build environment](http://www.sphinx-doc.org/en/master/extdev/envapi.html) via the variable `env`.\n",
26+
"You have access to the current [Sphinx build environment](https://www.sphinx-doc.org/en/master/extdev/envapi.html) via the variable `env`.\n",
2727
"Most notably, you can get the file name of the current notebook with\n",
2828
"\n",
2929
" {{ env.doc2path(env.docname, base=None) }}\n",
@@ -66,7 +66,7 @@
6666
"source": [
6767
"## Examples\n",
6868
"\n",
69-
"You can include a simple static string, using [reST](http://sphinx-doc.org/rest.html) markup if you like:\n",
69+
"You can include a simple static string, using [reST](https://www.sphinx-doc.org/rest.html) markup if you like:\n",
7070
"\n",
7171
"```python\n",
7272
"nbsphinx_epilog = \"\"\"\n",

doc/raw-cells.ipynb

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@
7272
"source": [
7373
"\"**I'm** a *raw cell* in reST_ format.\"\n",
7474
"\n",
75-
".. _reST: http://sphinx-doc.org/rest.html"
75+
".. _reST: https://www.sphinx-doc.org/rest.html"
7676
]
7777
},
7878
{

doc/subdir/toctree.ipynb

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
"source": [
1616
"# Using `toctree` In A Notebook\n",
1717
"\n",
18-
"In Sphinx-based documentation, there is typically a file called `index.rst` which contains one or more [toctree](http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree) directives.\n",
18+
"In Sphinx-based documentation, there is typically a file called `index.rst` which contains one or more [toctree](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree) directives.\n",
1919
"Those can be used to pull in further source files (which themselves can contain `toctree` directives).\n",
2020
"\n",
2121
"With `nbsphinx` it is possible to get a similar effect within a Jupyter notebook using the `\"nbsphinx-toctree\"` cell metadata.\n",
@@ -58,7 +58,7 @@
5858
" \"numbered\": true\n",
5959
" }\n",
6060
"\n",
61-
"For more options, have a look a the [Sphinx documentation](http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree).\n",
61+
"For more options, have a look a the [Sphinx documentation](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree).\n",
6262
"All options can be used -- except `:glob:`, which can only be used in [rst files](../a-normal-rst-file.rst) and in [raw reST cells](../raw-cells.ipynb#reST).\n",
6363
"\n",
6464
"Note that in the HTML output, a `toctree` cell generates an in-line table of contents (containing links) at its position in the notebook, whereas in the LaTeX output, a new (sub-)section with the actual content is inserted at its position.\n",

doc/usage.ipynb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
"source": [
2323
"## Sphinx Setup\n",
2424
"\n",
25-
"In the directory with your notebook files, run this command (assuming you have [Sphinx](http://sphinx-doc.org/) installed already):\n",
25+
"In the directory with your notebook files, run this command (assuming you have [Sphinx](https://www.sphinx-doc.org/) installed already):\n",
2626
"\n",
2727
" python3 -m sphinx.cmd.quickstart\n",
2828
"\n",
@@ -41,7 +41,7 @@
4141
"\n",
4242
"For an example, see this project's [conf.py](conf.py) file.\n",
4343
"\n",
44-
"Once your `conf.py` is in place, edit the file named `index.rst` and add the file names of your notebooks (without the `.ipynb` extension) to the [toctree](http://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree) directive.\n",
44+
"Once your `conf.py` is in place, edit the file named `index.rst` and add the file names of your notebooks (without the `.ipynb` extension) to the [toctree](https://www.sphinx-doc.org/en/master/usage/restructuredtext/directives.html#directive-toctree) directive.\n",
4545
"For an example, see this project's `doc/index.rst` file."
4646
]
4747
},
@@ -178,7 +178,7 @@
178178
"\n",
179179
"1. Create the file mentioned above.\n",
180180
"You can choose whatever name you want (it may also live in a subdirectory, e.g. `doc/environment.yml`), it just has to match whatever is specified in `readthedocs.yml`.\n",
181-
"The second file describes a [conda environment](https://conda.io/docs/using/envs.html) and should contain something like this:\n",
181+
"The second file describes a [conda environment](https://docs.conda.io/projects/conda/en/latest/user-guide/tasks/manage-environments.html) and should contain something like this:\n",
182182
"\n",
183183
" channels:\n",
184184
" - conda-forge\n",
@@ -229,7 +229,7 @@
229229
"source": [
230230
"## HTML Themes\n",
231231
"\n",
232-
"The `nbsphinx` extension does *not* provide its own theme, you can use any of the available themes or [create a custom one](http://www.sphinx-doc.org/en/master/theming.html#creating-themes), if you feel like it.\n",
232+
"The `nbsphinx` extension does *not* provide its own theme, you can use any of the available themes or [create a custom one](https://www.sphinx-doc.org/en/master/theming.html#creating-themes), if you feel like it.\n",
233233
"\n",
234234
"The following (incomplete) list of themes contains up to three links for each theme:\n",
235235
"\n",
@@ -350,7 +350,7 @@
350350
"* https://github.com/toobaz/ipynb_output_filter\n",
351351
"* http://tillahoffmann.github.io/2017/04/17/versioning-jupyter-notebooks-with-git.html\n",
352352
"* http://timstaley.co.uk/posts/making-git-and-jupyter-notebooks-play-nice/\n",
353-
"* http://pascalbugnion.net/blog/ipython-notebooks-and-git.html\n",
353+
"* https://pascalbugnion.net/blog/ipython-notebooks-and-git.html\n",
354354
"* https://github.com/choldgraf/nbclean"
355355
]
356356
}

0 commit comments

Comments
 (0)