diff --git a/EXAMPLES.rst b/EXAMPLES.rst index 5a787c36a..7e36522fc 100644 --- a/EXAMPLES.rst +++ b/EXAMPLES.rst @@ -29,7 +29,6 @@ Documentation using the alabaster theme * `Jinja `__ * `Lino `__ (customized) * `marbl `__ -* `MDAnalysis `__ (customized) * `MeshPy `__ * `Molecule `__ * `Momotor LTI `__ @@ -61,18 +60,18 @@ Documentation using the classic theme * `Buildbot `__ * `CMake `__ (customized) * `Chaco `__ (customized) -* `Cormoran `__ +* `Cormoran `__ * `DEAP `__ (customized) * `Director `__ -* `EZ-Draw `__ (customized) +* `EZ-Draw `__ (customized) * `Generic Mapping Tools (GMT) `__ (customized) * `Genomedata `__ * `GetFEM++ `__ (customized) * `Glasgow Haskell Compiler `__ (customized) -* `Grok `__ (customized) +* `Grok `__ (customized) * `GROMACS `__ * `GSL Shell `__ -* `Hands-on Python Tutorial `__ +* `Hands-on Python Tutorial `__ * `Kaa `__ (customized) * `Leo `__ (customized) * `Mayavi `__ (customized) @@ -80,33 +79,31 @@ Documentation using the classic theme * `mpmath `__ * `OpenCV `__ (customized) * `OpenEXR `__ -* `OpenGDA `__ +* `OpenGDA `__ * `phpDocumentor `__ (customized) * `Plone `__ (customized) * `PyEMD `__ -* `Pyevolve `__ +* `Pyevolve `__ * `Pygame `__ (customized) * `PyMQI `__ -* `PyQt4 `__ (customized) -* `PyQt5 `__ (customized) +* `PyQt4 `__ (customized) +* `PyQt5 `__ (customized) * `Python 2 `__ * `Python 3 `__ (customized) * `Python Packaging Authority `__ (customized) -* `Ring programming language `__ (customized) +* `Ring programming language `__ (customized) * `SageMath `__ (customized) * `Segway `__ -* `simuPOP `__ (customized) -* `Sprox `__ (customized) +* `simuPOP `__ (customized) * `SymPy `__ * `TurboGears `__ (customized) * `tvtk `__ * `Varnish `__ (customized, alabaster for index) * `Waf `__ * `wxPython Phoenix `__ (customized) -* `Yum `__ * `z3c `__ * `zc.async `__ (customized) -* `Zope `__ (customized) +* `Zope `__ (customized) Documentation using the sphinxdoc theme --------------------------------------- @@ -115,16 +112,15 @@ Documentation using the sphinxdoc theme * `cartopy `__ * `Jython `__ * `LLVM `__ -* `MDAnalysis Tutorial `__ * `PyCantonese `__ * `Pyre `__ * `pySPACE `__ -* `Pysparse `__ +* `Pysparse `__ * `PyTango `__ * `Python Wild Magic `__ (customized) * `RDKit `__ -* `Reteisi `__ (customized) -* `Sqlkit `__ (customized) +* `Reteisi `__ (customized) +* `Sqlkit `__ (customized) * `Turbulenz `__ Documentation using the nature theme @@ -141,7 +137,7 @@ Documentation using the nature theme * `Setuptools `__ * `Spring Python `__ * `StatsModels `__ (customized) -* `Sylli `__ +* `Sylli `__ Documentation using another builtin theme ----------------------------------------- @@ -225,7 +221,7 @@ Documentation using sphinx_rtd_theme * `Linux kernel `__ * `Mailman `__ * `MathJax `__ -* `MDTraj `__ (customized) +* `MDTraj `__ (customized) * `Mesa 3D `__ * `micca - MICrobial Community Analysis `__ * `MicroPython `__ @@ -268,7 +264,7 @@ Documentation using sphinx_rtd_theme * `Free your information from their silos (French) `__ (customized) * `Releases Sphinx extension `__ * `Qtile `__ -* `Quex `__ +* `Quex `__ * `QuTiP `__ * `Scapy `__ * `SimGrid `__ @@ -283,12 +279,11 @@ Documentation using sphinx_rtd_theme * `Sphinx with Github Webpages `__ * `SpotBugs `__ * `StarUML `__ -* `Sublime Text Unofficial Documentation `__ +* `Sublime Text Unofficial Documentation `__ * `SunPy `__ * `Sylius `__ * `Syncthing `__ * `Tango Controls `__ (customized) -* `Topshelf `__ * `ThreatConnect `__ * `TrueNAS `__ (customized) * `Tuleap `__ @@ -381,12 +376,11 @@ Documentation using a custom theme or integrated in a website * `ndnSIM `__ * `nose `__ * `ns-3 `__ -* `ObjectListView `__ +* `ObjectListView `__ * `OpenERP `__ * `OpenCV `__ * `Open Dylan `__ -* `OpenLayers `__ -* `OpenTURNS `__ +* `OpenTURNS `__ * `Open vSwitch `__ * `PlatformIO `__ * `Psycopg `__ @@ -407,7 +401,7 @@ Documentation using a custom theme or integrated in a website * `Substance D `__ * `Sulu `__ * `SQLAlchemy `__ -* `tinyTiM `__ +* `tinyTiM `__ * `Twisted `__ * `Ubuntu Packaging Guide `__ * `WTForms `__ @@ -415,7 +409,7 @@ Documentation using a custom theme or integrated in a website Homepages and other non-documentation sites ------------------------------------------- -* `Alan Crosswell's Using the Django REST Framework and DRF-JSONAPI `__ +* `Alan Crosswell's Using the Django REST Framework and DRF-JSONAPI `__ * `Arizona State University PHY494/PHY598/CHM598 Simulation approaches to Bio-and Nanophysics `__ (classic) * `Benoit Boissinot `__ (classic, customized) * `EBI Cloud Consultancy Team `__ (sphinx_rtd_theme) @@ -446,7 +440,7 @@ Books produced using Sphinx * `"Learning System Programming with Go (Japanese)" `__ * `"Mercurial: the definitive guide (Second edition)" `__ * `"Mithril -- The fastest clientside MVC (Japanese)" `__ -* `"Pioneers and Prominent Men of Utah" `__ +* "Pioneers and Prominent Men of Utah" * `"Pomodoro Technique Illustrated" (Japanese translation) `__ * `"Professional Software Development" `__ * `"Python Professional Programming" (in Japanese) `__ diff --git a/doc/faq.rst b/doc/faq.rst index 85ccb245e..8538cdc0c 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -107,7 +107,7 @@ Google Analytics (function() { var ga = document.createElement('script'); ga.src = ('https:' == document.location.protocol ? - 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + 'https://ssl' : 'https://www') + '.google-analytics.com/ga.js'; ga.setAttribute('async', 'true'); document.documentElement.firstChild.appendChild(ga); })(); diff --git a/doc/support.rst b/doc/support.rst index b7c6f01df..0d349a012 100644 --- a/doc/support.rst +++ b/doc/support.rst @@ -12,7 +12,7 @@ mailing list on Google Groups, come to the ``#sphinx-doc`` channel on Examples of other projects using Sphinx can be found in the :doc:`examples page `. A useful tutorial_ has been written by the matplotlib developers. -.. _tutorial: http://matplotlib.sourceforge.net/sampledoc/ +.. _tutorial: https://matplotlib.sourceforge.net/sampledoc/ There is a translation team in Transifex_ of this documentation, thanks to the Sphinx document translators. diff --git a/doc/tutorial/automatic-doc-generation.rst b/doc/tutorial/automatic-doc-generation.rst index b47673d18..8d9c9c9c7 100644 --- a/doc/tutorial/automatic-doc-generation.rst +++ b/doc/tutorial/automatic-doc-generation.rst @@ -160,6 +160,6 @@ originally used the corresponding ``autodoc`` directive, in this case in the .. note:: The generated files are based on `Jinja2 - templates `_ that + templates `_ that :ref:`can be customized `, but that is out of scope for this tutorial. diff --git a/doc/tutorial/describing-code.rst b/doc/tutorial/describing-code.rst index aac761f78..16feb2af3 100644 --- a/doc/tutorial/describing-code.rst +++ b/doc/tutorial/describing-code.rst @@ -246,7 +246,7 @@ C, C++, JavaScript, and reStructuredText. Third-party extensions may define domains for more languages, such as - `Fortran `_, -- `Julia `_, or +- `Julia `_, or - `PHP `_. For example, to document a C++ type definition, you would use the built-in diff --git a/doc/usage/builders/index.rst b/doc/usage/builders/index.rst index 92c88839d..36d5799cd 100644 --- a/doc/usage/builders/index.rst +++ b/doc/usage/builders/index.rst @@ -199,7 +199,7 @@ The most common builders are: This builder produces the same output as the standalone HTML builder, but also generates an *epub* file for ebook readers. See :ref:`epub-faq` for details about it. For definition of the epub format, have a look at - ``_ or ``_. + ``_ or ``_. The builder creates *EPUB 3* files. .. autoattribute:: name diff --git a/doc/usage/configuration.rst b/doc/usage/configuration.rst index cde97a7e6..2829b0827 100644 --- a/doc/usage/configuration.rst +++ b/doc/usage/configuration.rst @@ -1964,7 +1964,7 @@ the `Dublin Core metadata `_. Meta data for the guide element of :file:`content.opf`. This is a sequence of tuples containing the *type*, the *uri* and the *title* of the optional guide information. See the OPF documentation - at ``_ for details. If possible, default entries + at ``_ for details. If possible, default entries for the *cover* and *toc* types are automatically inserted. However, the types can be explicitly overwritten if the default entries are not appropriate. Example:: @@ -2367,7 +2367,7 @@ These options influence LaTeX output. usage). This means that words with UTF-8 characters will get ordered correctly for the :confval:`language`. - __ http://xindy.sourceforge.net/ + __ https://xindy.sourceforge.net/ - This option is ignored if :confval:`latex_engine` is ``'platex'`` (Japanese documents; :program:`mendex` replaces :program:`makeindex` @@ -2743,7 +2743,7 @@ Options for the linkcheck builder A list of regular expressions that match URIs that should not be checked when doing a ``linkcheck`` build. Example:: - linkcheck_ignore = [r'http://localhost:\d+/'] + linkcheck_ignore = [r'https://localhost:\d+/'] .. versionadded:: 1.1 diff --git a/doc/usage/extensions/math.rst b/doc/usage/extensions/math.rst index a6f7449b9..251d72117 100644 --- a/doc/usage/extensions/math.rst +++ b/doc/usage/extensions/math.rst @@ -316,5 +316,5 @@ package jsMath_. It provides this config value: .. _dvisvgm: https://dvisvgm.de/ .. _dvisvgm FAQ: https://dvisvgm.de/FAQ .. _MathJax: https://www.mathjax.org/ -.. _jsMath: http://www.math.union.edu/~dpvc/jsmath/ +.. _jsMath: https://www.math.union.edu/~dpvc/jsmath/ .. _LaTeX preview package: https://www.gnu.org/software/auctex/preview-latex.html diff --git a/doc/usage/restructuredtext/directives.rst b/doc/usage/restructuredtext/directives.rst index 4a1ce0e89..4e7985002 100644 --- a/doc/usage/restructuredtext/directives.rst +++ b/doc/usage/restructuredtext/directives.rst @@ -341,7 +341,7 @@ units as well as normal text. Module :py:mod:`zipfile` Documentation of the :py:mod:`zipfile` standard module. - `GNU tar manual, Basic Tar Format `_ + `GNU tar manual, Basic Tar Format `_ Documentation for tar archive files, including GNU tar extensions. There's also a "short form" allowed that looks like this:: diff --git a/sphinx/search/__init__.py b/sphinx/search/__init__.py index d8f7b5a2c..99c934a0f 100644 --- a/sphinx/search/__init__.py +++ b/sphinx/search/__init__.py @@ -121,7 +121,7 @@ def parse_stop_word(source: str) -> set[str]: """ Parse snowball style word list like this: - * http://snowball.tartarus.org/algorithms/finnish/stop.txt + * https://snowball.tartarus.org/algorithms/finnish/stop.txt """ result: set[str] = set() for line in source.splitlines(): diff --git a/sphinx/search/da.py b/sphinx/search/da.py index 9b5b9f5e3..1d3dec646 100644 --- a/sphinx/search/da.py +++ b/sphinx/search/da.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word danish_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/danish/stop.txt +| source: https://snowball.tartarus.org/algorithms/danish/stop.txt og | and i | in jeg | I diff --git a/sphinx/search/de.py b/sphinx/search/de.py index 1c253fdf7..4f14913fa 100644 --- a/sphinx/search/de.py +++ b/sphinx/search/de.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word german_stopwords = parse_stop_word(''' -|source: http://snowball.tartarus.org/algorithms/german/stop.txt +|source: https://snowball.tartarus.org/algorithms/german/stop.txt aber | but alle | all diff --git a/sphinx/search/es.py b/sphinx/search/es.py index c5d9a5c79..517d7eb3e 100644 --- a/sphinx/search/es.py +++ b/sphinx/search/es.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word spanish_stopwords = parse_stop_word(''' -|source: http://snowball.tartarus.org/algorithms/spanish/stop.txt +|source: https://snowball.tartarus.org/algorithms/spanish/stop.txt de | from, of la | the, her que | who, that diff --git a/sphinx/search/fi.py b/sphinx/search/fi.py index 70114f876..d1e3645bd 100644 --- a/sphinx/search/fi.py +++ b/sphinx/search/fi.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word finnish_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/finnish/stop.txt +| source: https://snowball.tartarus.org/algorithms/finnish/stop.txt | forms of BE olla diff --git a/sphinx/search/fr.py b/sphinx/search/fr.py index 01319dd86..9ae72ebc6 100644 --- a/sphinx/search/fr.py +++ b/sphinx/search/fr.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word french_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/french/stop.txt +| source: https://snowball.tartarus.org/algorithms/french/stop.txt au | a + le aux | a + les avec | with diff --git a/sphinx/search/hu.py b/sphinx/search/hu.py index eed08dbde..c2c2c6c7e 100644 --- a/sphinx/search/hu.py +++ b/sphinx/search/hu.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word hungarian_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/hungarian/stop.txt +| source: https://snowball.tartarus.org/algorithms/hungarian/stop.txt | prepared by Anna Tordai a ahogy diff --git a/sphinx/search/it.py b/sphinx/search/it.py index 7bf712b77..1ac0146ba 100644 --- a/sphinx/search/it.py +++ b/sphinx/search/it.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word italian_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/italian/stop.txt +| source: https://snowball.tartarus.org/algorithms/italian/stop.txt ad | a (to) before vowel al | a + il allo | a + lo diff --git a/sphinx/search/ja.py b/sphinx/search/ja.py index de221ced1..d1e912681 100644 --- a/sphinx/search/ja.py +++ b/sphinx/search/ja.py @@ -1,12 +1,12 @@ """Japanese search language: includes routine to split words.""" # Python Version of TinySegmenter -# (http://chasen.org/~taku/software/TinySegmenter/) +# (https://chasen.org/~taku/software/TinySegmenter/) # TinySegmenter is super compact Japanese tokenizer. # # TinySegmenter was originally developed by Taku Kudo . # Python Version was developed by xnights . -# For details, see http://programming-magic.com/?id=170 +# For details, see https://programming-magic.com/?id=170 from __future__ import annotations diff --git a/sphinx/search/nl.py b/sphinx/search/nl.py index a610b12db..b9a3dec64 100644 --- a/sphinx/search/nl.py +++ b/sphinx/search/nl.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word dutch_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/dutch/stop.txt +| source: https://snowball.tartarus.org/algorithms/dutch/stop.txt de | the en | and van | of, from diff --git a/sphinx/search/no.py b/sphinx/search/no.py index a69380b41..7382f78a6 100644 --- a/sphinx/search/no.py +++ b/sphinx/search/no.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word norwegian_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/norwegian/stop.txt +| source: https://snowball.tartarus.org/algorithms/norwegian/stop.txt og | and i | in jeg | I diff --git a/sphinx/search/pt.py b/sphinx/search/pt.py index 908a4179c..f370aaf46 100644 --- a/sphinx/search/pt.py +++ b/sphinx/search/pt.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word portuguese_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/portuguese/stop.txt +| source: https://snowball.tartarus.org/algorithms/portuguese/stop.txt de | of, from a | the; to, at; her o | the; him diff --git a/sphinx/search/ru.py b/sphinx/search/ru.py index b8412c1e8..3a0e5376d 100644 --- a/sphinx/search/ru.py +++ b/sphinx/search/ru.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word russian_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/russian/stop.txt +| source: https://snowball.tartarus.org/algorithms/russian/stop.txt и | and в | in/into во | alternative form diff --git a/sphinx/search/sv.py b/sphinx/search/sv.py index 88cc5602d..2226d158f 100644 --- a/sphinx/search/sv.py +++ b/sphinx/search/sv.py @@ -9,7 +9,7 @@ import snowballstemmer from sphinx.search import SearchLanguage, parse_stop_word swedish_stopwords = parse_stop_word(''' -| source: http://snowball.tartarus.org/algorithms/swedish/stop.txt +| source: https://snowball.tartarus.org/algorithms/swedish/stop.txt och | and det | it, this/that att | to (with infinitive) diff --git a/sphinx/texinputs/sphinx.xdy b/sphinx/texinputs/sphinx.xdy index 0dcf1133c..8df526e51 100644 --- a/sphinx/texinputs/sphinx.xdy +++ b/sphinx/texinputs/sphinx.xdy @@ -99,7 +99,7 @@ ;; file, with a blank space after \IeC ;; Details of the syntax are explained at -;; http://xindy.sourceforge.net/doc/manual-3.html +;; https://xindy.sourceforge.net/doc/manual-3.html ;; In absence of :string, "xindy uses an auto-detection mechanism to decide, ;; if the pattern is a regular expression or not". But it is not obvious to ;; guess, for example "\\_" is not detected as RE but "\\P\{\}" is, so for diff --git a/sphinx/themes/bizstyle/static/css3-mediaqueries_src.js b/sphinx/themes/bizstyle/static/css3-mediaqueries_src.js index 787862027..8aedaab99 100644 --- a/sphinx/themes/bizstyle/static/css3-mediaqueries_src.js +++ b/sphinx/themes/bizstyle/static/css3-mediaqueries_src.js @@ -4,15 +4,15 @@ css3-mediaqueries.js - CSS Helper and CSS3 Media Queries Enabler author: Wouter van der Graaf version: 1.0 (20110330) license: MIT -website: http://code.google.com/p/css3-mediaqueries-js/ +website: https://code.google.com/p/css3-mediaqueries-js/ -W3C spec: http://www.w3.org/TR/css3-mediaqueries/ +W3C spec: https://www.w3.org/TR/css3-mediaqueries/ Note: use of embedded