From dd383ec4721d45202fc627fc61102076b5bebc34 Mon Sep 17 00:00:00 2001 From: Jon Dufresne Date: Sun, 23 Sep 2018 09:36:25 -0700 Subject: [PATCH] Prefer https:// links where available --- CHANGES | 2 +- EXAMPLES | 96 +++++++++++++++++------------------ doc/develop.rst | 2 +- doc/faq.rst | 2 +- doc/intl.rst | 2 +- doc/usage/builders/index.rst | 2 +- doc/usage/extensions/math.rst | 2 +- doc/usage/installation.rst | 10 ++-- doc/usage/markdown.rst | 2 +- sphinx/builders/htmlhelp.py | 5 +- sphinx/domains/cpp.py | 6 +-- sphinx/util/stemmer/porter.py | 2 +- tests/test_domain_cpp.py | 2 +- 13 files changed, 68 insertions(+), 67 deletions(-) diff --git a/CHANGES b/CHANGES index f7e7884bc..0cc492e2b 100644 --- a/CHANGES +++ b/CHANGES @@ -2136,7 +2136,7 @@ Incompatible changes parsing is attempted to distinguish valid code. To get the old behavior back, add ``highlight_language = "python"`` to conf.py. * `Locale Date Markup Language - `_ like + `_ like ``"MMMM dd, YYYY"`` is default format for `today_fmt` and `html_last_updated_fmt`. However strftime format like ``"%B %d, %Y"`` is also supported for backward compatibility until Sphinx-1.5. Later format will be disabled from Sphinx-1.5. diff --git a/EXAMPLES b/EXAMPLES index ef4cf17fe..2dd0373f2 100644 --- a/EXAMPLES +++ b/EXAMPLES @@ -18,15 +18,15 @@ Documentation using the alabaster theme * `Click `__ (customized) * `coala `__ (customized) * `CodePy `__ -* `Fabric `__ -* `Fityk `__ +* `Fabric `__ +* `Fityk `__ * `Flask `__ * `Flask-OpenID `__ -* `Invoke `__ +* `Invoke `__ * `Jinja `__ * `Lino `__ (customized) * `marbl `__ -* `MDAnalysis `__ (customized) +* `MDAnalysis `__ (customized) * `MeshPy `__ * `PyCUDA `__ * `PyOpenCL `__ @@ -54,27 +54,27 @@ Documentation using the classic theme * `Bugzilla `__ * `Buildbot `__ * `CMake `__ (customized) -* `Chaco `__ (customized) +* `Chaco `__ (customized) * `Cormoran `__ * `DEAP `__ (customized) * `Director `__ * `EZ-Draw `__ (customized) * `F2py `__ -* `Generic Mapping Tools (GMT) `__ (customized) +* `Generic Mapping Tools (GMT) `__ (customized) * `Genomedata `__ * `GetFEM++ `__ (customized) * `Glasgow Haskell Compiler `__ (customized) * `Grok `__ (customized) * `GROMACS `__ -* `GSL Shell `__ -* `Hands-on Python Tutorial `__ -* `Kaa `__ (customized) -* `Leo `__ +* `GSL Shell `__ +* `Hands-on Python Tutorial `__ +* `Kaa `__ (customized) +* `Leo `__ * `LEPL `__ (customized) -* `Mayavi `__ (customized) +* `Mayavi `__ (customized) * `MediaGoblin `__ (customized) * `mpmath `__ -* `OpenCV `__ (customized) +* `OpenCV `__ (customized) * `OpenEXR `__ * `OpenGDA `__ * `Peach^3 `__ (customized) @@ -90,32 +90,32 @@ Documentation using the classic theme * `Python Packaging Authority `__ (customized) * `Ring programming language `__ (customized) * `SageMath `__ (customized) -* `Segway `__ +* `Segway `__ * `simuPOP `__ (customized) * `Sprox `__ (customized) -* `SymPy `__ +* `SymPy `__ * `TurboGears `__ (customized) -* `tvtk `__ +* `tvtk `__ * `Varnish `__ (customized, alabaster for index) * `Waf `__ * `wxPython Phoenix `__ (customized -* `z3c `__ +* `z3c `__ * `zc.async `__ (customized) * `Zope `__ (customized) Documentation using the sphinxdoc theme --------------------------------------- -* `cartopy `__ +* `cartopy `__ * `Jython `__ * `Matplotlib `__ -* `MDAnalysis Tutorial `__ +* `MDAnalysis Tutorial `__ * `NetworkX `__ * `PyCantonese `__ * `Pyre `__ * `pySPACE `__ * `Pysparse `__ -* `PyTango `__ +* `PyTango `__ * `Python Wild Magic `__ (customized) * `Reteisi `__ (customized) * `Sqlkit `__ (customized) @@ -130,12 +130,12 @@ Documentation using the nature theme * `jsFiddle `__ * `libLAS `__ (customized) * `Lmod `__ -* `MapServer `__ (customized) +* `MapServer `__ (customized) * `Pandas `__ * `pyglet `__ (customized) * `Setuptools `__ * `Spring Python `__ -* `StatsModels `__ (customized) +* `StatsModels `__ (customized) * `Sylli `__ Documentation using another builtin theme @@ -143,13 +143,13 @@ Documentation using another builtin theme * `Breathe `__ (haiku) * `MPipe `__ (sphinx13) -* `NLTK `__ (agogo) -* `Programmieren mit PyGTK und Glade (German) `__ (agogo, customized) +* `NLTK `__ (agogo) +* `Programmieren mit PyGTK und Glade (German) `__ (agogo, customized) * `PyPubSub `__ (bizstyle) -* `Pylons `__ (pyramid) +* `Pylons `__ (pyramid) * `Pyramid web framework `__ (pyramid) * `Sphinx `__ (sphinx13) :-) -* `Valence `__ (haiku, customized) +* `Valence `__ (haiku, customized) Documentation using sphinx_rtd_theme ------------------------------------ @@ -165,14 +165,14 @@ Documentation using sphinx_rtd_theme * `bootstrap-datepicker `__ * `Certbot `__ * `Chainer `__ (customized) -* `CherryPy `__ +* `CherryPy `__ * `CodeIgniter `__ * `Conda `__ * `Corda `__ * `Dask `__ * `Databricks `__ (customized) * `Dataiku DSS `__ -* `edX `__ +* `edX `__ * `Electrum `__ * `Elemental `__ * `ESWP3 `__ @@ -228,17 +228,17 @@ Documentation using sphinx_rtd_theme * `Quex `__ * `Satchmo `__ * `Scapy `__ -* `SimPy `__ -* `SlamData `__ +* `SimPy `__ +* `SlamData `__ * `Solidity `__ * `Sonos Controller (SoCo) `__ * `Sphinx AutoAPI `__ * `sphinx-argparse `__ * `Sphinx-Gallery `__ (customized) * `SpotBugs `__ -* `StarUML `__ +* `StarUML `__ * `Sublime Text Unofficial Documentation `__ -* `SunPy `__ +* `SunPy `__ * `Sylius `__ * `Tango Controls `__ (customized) * `Topshelf `__ @@ -247,7 +247,7 @@ Documentation using sphinx_rtd_theme * `Tuleap `__ * `TYPO3 `__ (customized) * `uWSGI `__ -* `Wagtail `__ +* `Wagtail `__ * `Web Application Attack and Audit Framework (w3af) `__ * `Weblate `__ * `x265 `__ @@ -257,7 +257,7 @@ Documentation using sphinx_bootstrap_theme ------------------------------------------ * `Bootstrap Theme `__ -* `C/C++ Software Development with Eclipse `__ +* `C/C++ Software Development with Eclipse `__ * `Dataverse `__ * `e-cidadania `__ * `Hangfire `__ @@ -279,16 +279,16 @@ Documentation using a custom theme or integrated in a website * `CasperJS `__ * `Ceph `__ * `Chef `__ -* `CKAN `__ -* `Confluent Platform `__ +* `CKAN `__ +* `Confluent Platform `__ * `Django `__ -* `Doctrine `__ +* `Doctrine `__ * `Enterprise Toolkit for Acrobat products `__ * `Gameduino `__ * `gensim `__ * `GeoServer `__ * `gevent `__ -* `GHC - Glasgow Haskell Compiler `__ +* `GHC - Glasgow Haskell Compiler `__ * `Guzzle `__ * `H2O.ai `__ * `Istihza (Turkish Python documentation project) `__ @@ -297,18 +297,18 @@ Documentation using a custom theme or integrated in a website * `Mako `__ * `MirrorBrain `__ * `MongoDB `__ -* `Music21 `__ +* `Music21 `__ * `MyHDL `__ * `nose `__ * `ns-3 `__ * `NumPy `__ * `ObjectListView `__ * `OpenERP `__ -* `OpenCV `__ +* `OpenCV `__ * `OpenLayers `__ -* `OpenTURNS `__ +* `OpenTURNS `__ * `Open vSwitch `__ -* `PlatformIO `__ +* `PlatformIO `__ * `PyEphem `__ * `Pygments `__ * `Plone User Manual (German) `__ @@ -316,20 +316,20 @@ Documentation using a custom theme or integrated in a website * `PyMOTW `__ * `python-aspectlib `__ (`sphinx_py3doc_enhanced_theme `__) * `QGIS `__ -* `qooxdoo `__ +* `qooxdoo `__ * `Roundup `__ * `SaltStack `__ * `scikit-learn `__ * `SciPy `__ * `Scrapy `__ * `Seaborn `__ -* `Selenium `__ +* `Selenium `__ * `Self `__ * `Substance D `__ * `Sulu `__ * `SQLAlchemy `__ * `tinyTiM `__ -* `Twisted `__ +* `Twisted `__ * `Ubuntu Packaging Guide `__ * `WebFaction `__ * `WTForms `__ @@ -341,12 +341,12 @@ Homepages and other non-documentation sites * `Benoit Boissinot `__ (classic, customized) * `Computer Networks, Parallelization, and Simulation Laboratory (CNPSLab) `__ (sphinx_rtd_theme) * `Deep Learning Tutorials `__ (sphinxdoc) -* `Loyola University Chicago COMP 339-439 Distributed Systems course `__ (sphinx_bootstrap_theme) +* `Loyola University Chicago COMP 339-439 Distributed Systems course `__ (sphinx_bootstrap_theme) * `Pylearn2 `__ (sphinxdoc, customized) * `PyXLL `__ (sphinx_bootstrap_theme, customized) * `SciPy Cookbook `__ (sphinx_rtd_theme) * `The Wine Cellar Book `__ (sphinxdoc) -* `Thomas Cokelaer's Python, Sphinx and reStructuredText tutorials `__ (standard) +* `Thomas Cokelaer's Python, Sphinx and reStructuredText tutorials `__ (standard) * `UC Berkeley ME233 Advanced Control Systems II course `__ (sphinxdoc) Books produced using Sphinx @@ -357,7 +357,7 @@ Books produced using Sphinx * `"Expert Python Programming" `__ * `"Expert Python Programming" (Japanese translation) `__ * `"Expert Python Programming 2nd Edition" (Japanese translation) `__ -* `"The Hitchhiker's Guide to Python" `__ +* `"The Hitchhiker's Guide to Python" `__ * `"LassoGuide" `__ * `"Learning Sphinx" (in Japanese) `__ * `"Learning System Programming with Go (Japanese)" `__ @@ -374,7 +374,7 @@ Books produced using Sphinx * `"The Self-Taught Programmer" (Japanese translation) `__ * `"Simple and Steady Way of Learning for Software Engineering" (in Japanese) `__ * `"Software-Dokumentation mit Sphinx" `__ -* `"Theoretical Physics Reference" `__ +* `"Theoretical Physics Reference" `__ * `"The Varnish Book" `__ Theses produced using Sphinx diff --git a/doc/develop.rst b/doc/develop.rst index d2a51b8e2..60ccaf79b 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -127,7 +127,7 @@ own extensions. .. _NumPy style: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt .. _hyphenator: https://github.com/mnater/hyphenator .. _exceltable: https://pythonhosted.org/sphinxcontrib-exceltable/ -.. _YouTube: http://www.youtube.com/ +.. _YouTube: https://www.youtube.com/ .. _ClearQuest: https://www.ibm.com/us-en/marketplace/rational-clearquest .. _Zope interfaces: https://zopeinterface.readthedocs.io/en/latest/README.html .. _slideshare: https://www.slideshare.net/ diff --git a/doc/faq.rst b/doc/faq.rst index b2d6cc9e6..021143f40 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -205,7 +205,7 @@ The following list gives some hints for the creation of epub files: .. _Epubcheck: https://github.com/IDPF/epubcheck .. _Calibre: https://calibre-ebook.com/ .. _FBreader: https://fbreader.org/ -.. _Bookworm: http://www.oreilly.com/bookworm/index.html +.. _Bookworm: https://www.oreilly.com/bookworm/index.html .. _kindlegen: https://www.amazon.com/gp/feature.html?docId=1000765211 .. _texinfo-faq: diff --git a/doc/intl.rst b/doc/intl.rst index 129665dde..ab062dca1 100644 --- a/doc/intl.rst +++ b/doc/intl.rst @@ -326,4 +326,4 @@ There is `sphinx translation page`_ for Sphinx (master) documentation. .. _`sphinx-intl`: https://pypi.org/project/sphinx-intl/ .. _Transifex: https://www.transifex.com/ .. _`sphinx translation page`: https://www.transifex.com/sphinx-doc/sphinx-doc/ -.. _`Transifex Client documentation`: http://docs.transifex.com/developer/client/ +.. _`Transifex Client documentation`: https://docs.transifex.com/client/introduction/ diff --git a/doc/usage/builders/index.rst b/doc/usage/builders/index.rst index 80c9b65ac..e7ad13bd1 100644 --- a/doc/usage/builders/index.rst +++ b/doc/usage/builders/index.rst @@ -216,7 +216,7 @@ Note that a direct PDF builder is being provided by `rinohtype`_. The builder's name is ``rinoh``. Refer to the `rinohtype manual`_ for details. .. _rinohtype: https://github.com/brechtm/rinohtype -.. _rinohtype manual: http://www.mos6581.org/rinohtype/quickstart.html#sphinx-builder +.. _rinohtype manual: https://www.mos6581.org/rinohtype/quickstart.html#sphinx-builder .. module:: sphinx.builders.text .. class:: TextBuilder diff --git a/doc/usage/extensions/math.rst b/doc/usage/extensions/math.rst index 9daa03186..9e62c1425 100644 --- a/doc/usage/extensions/math.rst +++ b/doc/usage/extensions/math.rst @@ -183,7 +183,7 @@ Sphinx. The default is empty (not configured). -.. _Using in-line configuration options: http://docs.mathjax.org/en/latest/configuration.html#using-in-line-configuration-options +.. _Using in-line configuration options: https://docs.mathjax.org/en/latest/configuration.html#using-in-line-configuration-options :mod:`sphinx.ext.jsmath` -- Render math via JavaScript ------------------------------------------------------ diff --git a/doc/usage/installation.rst b/doc/usage/installation.rst index 5c0d7de75..d5a7211cc 100644 --- a/doc/usage/installation.rst +++ b/doc/usage/installation.rst @@ -15,7 +15,7 @@ Overview Sphinx is written in `Python`__ and supports both Python 2.7 and Python 3.3+. We recommend the latter. -__ http://docs.python-guide.org/en/latest/ +__ https://docs.python-guide.org/ Linux @@ -73,7 +73,7 @@ Homebrew For more information, refer to the `package overview`__. -__ http://formulae.brew.sh/formula/sphinx-doc +__ https://formulae.brew.sh/formula/sphinx-doc MacPorts ~~~~~~~~ @@ -121,9 +121,9 @@ Once Python is installed, you can install Sphinx using :command:`pip`. Refer to the :ref:`pip installation instructions ` below for more information. -__ http://docs.python-guide.org/en/latest/ -__ http://docs.python-guide.org/en/latest/starting/install3/win/ -__ http://docs.python-guide.org/en/latest/starting/install/win/ +__ https://docs.python-guide.org/ +__ https://docs.python-guide.org/starting/install3/win/ +__ https://docs.python-guide.org/starting/install/win/ .. _install-pypi: diff --git a/doc/usage/markdown.rst b/doc/usage/markdown.rst index f67b94cbd..ed0cce013 100644 --- a/doc/usage/markdown.rst +++ b/doc/usage/markdown.rst @@ -15,7 +15,7 @@ parsing the `CommonMark`__ Markdown flavor. __ https://daringfireball.net/projects/markdown/ __ https://recommonmark.readthedocs.io/en/latest/index.html __ https://github.com/rtfd/CommonMark-py -__ http://commonmark.org/ +__ https://commonmark.org/ Configuration ------------- diff --git a/sphinx/builders/htmlhelp.py b/sphinx/builders/htmlhelp.py index 4d5172a8f..252e5050d 100644 --- a/sphinx/builders/htmlhelp.py +++ b/sphinx/builders/htmlhelp.py @@ -133,8 +133,9 @@ that the their then there these they this to was will with """.split() -# The following list includes only languages supported by Sphinx. -# See http://msdn.microsoft.com/en-us/library/ms930130.aspx for more. +# The following list includes only languages supported by Sphinx. See +# https://docs.microsoft.com/en-us/previous-versions/windows/embedded/ms930130(v=msdn.10) +# for more. chm_locales = { # lang: LCID, encoding 'ca': (0x403, 'cp1252'), diff --git a/sphinx/domains/cpp.py b/sphinx/domains/cpp.py index 81ad46ee7..190f95bfc 100644 --- a/sphinx/domains/cpp.py +++ b/sphinx/domains/cpp.py @@ -72,7 +72,7 @@ logger = logging.getLogger(__name__) Grammar ---------------------------------------------------------------------------- - See http://www.nongnu.org/hcb/ for the grammar, + See https://www.nongnu.org/hcb/ for the grammar, and https://github.com/cplusplus/draft/blob/master/source/grammar.tex, and https://github.com/cplusplus/concepts-ts for the newest grammar. @@ -336,7 +336,7 @@ _fold_operator_re = re.compile(r'''(?x) | != | [<>=/*%+|&^~-]=? ''') -# see http://en.cppreference.com/w/cpp/keyword +# see https://en.cppreference.com/w/cpp/keyword _keywords = [ 'alignas', 'alignof', 'and', 'and_eq', 'asm', 'auto', 'bitand', 'bitor', 'bool', 'break', 'case', 'catch', 'char', 'char16_t', 'char32_t', 'class', @@ -4295,7 +4295,7 @@ class Symbol: class DefinitionParser: # those without signedness and size modifiers - # see http://en.cppreference.com/w/cpp/language/types + # see https://en.cppreference.com/w/cpp/language/types _simple_fundemental_types = ( 'void', 'bool', 'char', 'wchar_t', 'char16_t', 'char32_t', 'int', 'float', 'double', 'auto' diff --git a/sphinx/util/stemmer/porter.py b/sphinx/util/stemmer/porter.py index 05abac644..4f2f1a089 100644 --- a/sphinx/util/stemmer/porter.py +++ b/sphinx/util/stemmer/porter.py @@ -14,7 +14,7 @@ only differing from it at the points maked --DEPARTURE-- below. - See also http://www.tartarus.org/~martin/PorterStemmer + See also https://tartarus.org/martin/PorterStemmer/ The algorithm as described in the paper could be exactly replicated by adjusting the points of DEPARTURE, but this is barely necessary, diff --git a/tests/test_domain_cpp.py b/tests/test_domain_cpp.py index a68cb008c..0d47f69b2 100644 --- a/tests/test_domain_cpp.py +++ b/tests/test_domain_cpp.py @@ -86,7 +86,7 @@ def check(name, input, idDict, output=None): def test_fundamental_types(): - # see http://en.cppreference.com/w/cpp/language/types + # see https://en.cppreference.com/w/cpp/language/types for t, id_v2 in cppDomain._id_fundamental_v2.items(): def makeIdV1(): if t == 'decltype(auto)':