From ff7eb28c3bef400900b4d89a293ce970a2e2123f Mon Sep 17 00:00:00 2001 From: Anton Akhmerov <anton.akhmerov@gmail.com> Date: Thu, 18 May 2017 15:44:44 +0200 Subject: [PATCH] update links in documentation In addition to basic updates to skip permanent redirect, remove an obsolete reference to macports installation instructions on the main website. --- AUTHORS.rst | 2 +- INSTALL.rst | 10 +++------- doc/source/reference/kwant.solvers.sparse.rst | 2 +- doc/source/tutorial/first_steps.rst | 2 +- doc/source/tutorial/spectrum.rst | 4 ++-- 5 files changed, 8 insertions(+), 12 deletions(-) diff --git a/AUTHORS.rst b/AUTHORS.rst index 6dfbeb85..b447190a 100644 --- a/AUTHORS.rst +++ b/AUTHORS.rst @@ -7,7 +7,7 @@ The Kwant authors can be reached at authors@kwant-project.org. The principal developers of Kwant are * `Christoph W. Groth <mailto://christoph.groth@cea.fr>`_ (INAC/CEA Grenoble) -* `Michael Wimmer <http://michaelwimmer.org>`_ (TU Delft) +* `Michael Wimmer <https://michaelwimmer.org>`_ (TU Delft) * `Anton R. Akhmerov <http://antonakhmerov.org>`_ (TU Delft) * `Xavier Waintal <http://inac.cea.fr/Pisp/xavier.waintal>`_ (INAC/CEA Grenoble) * `Joseph Weston <http://josephweston.org>`_ (INAC/CEA Grenoble) diff --git a/INSTALL.rst b/INSTALL.rst index 5da891c8..c7cc5df8 100644 --- a/INSTALL.rst +++ b/INSTALL.rst @@ -32,7 +32,7 @@ Building Kwant requires * `Python <https://www.python.org/>`_ 3.4 or above (Kwant 1.1 is the last version to support Python 2), * `NumPy <http://numpy.org/>`_ 1.8.1 or newer, - * `SciPy <http://scipy.org/>`_ 0.13.3 or newer, + * `SciPy <https://scipy.org/>`_ 0.13.3 or newer, * `LAPACK <http://netlib.org/lapack/>`_ and `BLAS <http://netlib.org/blas/>`_, (For best performance we recommend the free `OpenBLAS <http://www.openblas.net/>`_ or the nonfree `MKL @@ -156,7 +156,7 @@ Building the documentation To build the documentation, the `Sphinx documentation generator <http://www.sphinx-doc.org/en/stable/>`_ is required with ``numpydoc`` extension (version 0.5 or newer). If PDF documentation is to be built, the tools -from the `libRSVG <http://live.gnome.org/LibRsvg>`_ (Debian/Ubuntu package +from the `libRSVG <https://wiki.gnome.org/action/show/Projects/LibRsvg>`_ (Debian/Ubuntu package ``librsvg2-bin``) are needed to convert SVG drawings into the PDF format. As a prerequisite for building the documentation, Kwant must have been built @@ -216,11 +216,7 @@ systems. Here we only consider the case of `MacPorts below. 1. Install a recent version of MacPorts, as explained in the `installation - instructions of MacPorts <https://www.macports.org/install.php>`_. `The - MacPorts section of the Kwant website - <https://kwant-project.org/install#mac-os-x-macports>`_ may be also of - interest. (Note that it describes how to install Kwant using a ports file, - while the aim here is to install from source manually.) + instructions of MacPorts <https://www.macports.org/install.php>`_. 2. Install the required dependencies:: diff --git a/doc/source/reference/kwant.solvers.sparse.rst b/doc/source/reference/kwant.solvers.sparse.rst index c320c0e8..1cac13d3 100644 --- a/doc/source/reference/kwant.solvers.sparse.rst +++ b/doc/source/reference/kwant.solvers.sparse.rst @@ -4,7 +4,7 @@ .. module:: kwant.solvers.sparse This solver uses SciPy's `scipy.sparse.linalg -<http://docs.scipy.org/doc/scipy/reference/sparse.linalg.html>`_. The +<https://docs.scipy.org/doc/scipy/reference/sparse.linalg.html>`_. The interface is identical to that of the :mod:`default solver <kwant.solvers.default>`. diff --git a/doc/source/tutorial/first_steps.rst b/doc/source/tutorial/first_steps.rst index 6aac3667..fee31fce 100644 --- a/doc/source/tutorial/first_steps.rst +++ b/doc/source/tutorial/first_steps.rst @@ -325,7 +325,7 @@ subbands that increases with energy. .. rubric:: Footnotes -.. [#] http://xkcd.com/353/ +.. [#] https://xkcd.com/353/ .. [#] Leads are numbered in the python convention, starting from 0. Building the same system with less code diff --git a/doc/source/tutorial/spectrum.rst b/doc/source/tutorial/spectrum.rst index 3d92372d..b119e3c7 100644 --- a/doc/source/tutorial/spectrum.rst +++ b/doc/source/tutorial/spectrum.rst @@ -71,7 +71,7 @@ In this example, we compute the wave functions of a closed circular quantum dot and its spectrum as a function of magnetic field (Fock-Darwin spectrum). To compute the eigenenergies and eigenstates, we will make use of the sparse -linear algebra functionality of `SciPy <http://www.scipy.org>`_, which +linear algebra functionality of `SciPy <https://www.scipy.org>`_, which interfaces the ARPACK package: .. literalinclude:: closed_system.py @@ -139,7 +139,7 @@ it using `kwant.plotter.current`: matrix, if the optional argument ``sparse=True``. The sparse matrix is in SciPy's ``scipy.sparse.coo_matrix`` format, which can be easily be converted to various other sparse matrix formats (see `SciPy's documentation - <http://docs.scipy.org/doc/scipy/reference/>`_). + <https://docs.scipy.org/doc/scipy/reference/>`_). .. rubric:: Footnotes -- GitLab