diff --git a/AUTHORS b/AUTHORS index 69c224df0..696affa25 100644 --- a/AUTHORS +++ b/AUTHORS @@ -48,6 +48,7 @@ Other contributors, listed alphabetically, are: * Will Maier -- directory HTML builder * Jacob Mason -- websupport library (GSOC project) * Glenn Matthews -- python domain signature improvements +* Kurt McKee -- documentation updates * Roland Meister -- epub builder * Ezio Melotti -- collapsible sidebar JavaScript * Bruce Mitchener -- Minor epub improvement diff --git a/doc/_templates/index.html b/doc/_templates/index.html index 5a8a2f025..f5a80d5ad 100644 --- a/doc/_templates/index.html +++ b/doc/_templates/index.html @@ -98,7 +98,7 @@

{%trans%}There is a Japanese translation of this documentation, thanks to the Japanese Sphinx user group.{%endtrans%}

{%trans%}A Japanese book about Sphinx has been published by O'Reilly: - Sphinxをはじめよう / + Sphinxをはじめよう / Learning Sphinx.{%endtrans%}

diff --git a/doc/_templates/indexsidebar.html b/doc/_templates/indexsidebar.html index b07ef2033..668070579 100644 --- a/doc/_templates/indexsidebar.html +++ b/doc/_templates/indexsidebar.html @@ -1,4 +1,4 @@ - @@ -19,9 +19,9 @@ Index, or install it with:{%endtrans%}

{%trans%}Questions? Suggestions?{%endtrans%}

-

{%trans%}Join the sphinx-users mailing list on Google Groups:{%endtrans%}

+

{%trans%}Join the sphinx-users mailing list on Google Groups:{%endtrans%}

-
diff --git a/doc/builders.rst b/doc/builders.rst index ff56881af..ec550e825 100644 --- a/doc/builders.rst +++ b/doc/builders.rst @@ -216,7 +216,7 @@ instructions. .. _rinohtype: https://github.com/brechtm/rinohtype .. _rinohtype manual: http://www.mos6581.org/rinohtype/quickstart.html#sphinx-builder .. _rst2pdf: https://github.com/rst2pdf/rst2pdf -.. _rst2pdf manual: http://ralsina.me/static/manual.pdf +.. _rst2pdf manual: https://ralsina.me/static/manual.pdf .. module:: sphinx.builders.text .. class:: TextBuilder diff --git a/doc/develop.rst b/doc/develop.rst index 19ca81ef9..af0302367 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -12,7 +12,7 @@ Sphinx is a maintained by a group of volunteers. We value every contribution! * The mailing list for development is at `Google Groups `_. * There is also the #sphinx-doc IRC channel on `freenode - `_. + `_. For more about our development process and methods, see the :doc:`devguide`. @@ -106,37 +106,37 @@ own extensions. .. _aafigure: https://launchpad.net/aafigure .. _gnuplot: http://www.gnuplot.info/ -.. _paver: http://paver.github.io/paver/ -.. _Sword: http://www.crosswire.org/sword/ +.. _paver: https://paver.readthedocs.io/en/latest/ +.. _Sword: https://www.crosswire.org/sword/ .. _Lilypond: http://lilypond.org/ .. _sdedit: http://sdedit.sourceforge.net/ -.. _Trac: http://trac.edgewall.org -.. _TracLinks: http://trac.edgewall.org/wiki/TracLinks -.. _OmegaT: http://www.omegat.org/ +.. _Trac: https://trac.edgewall.org/ +.. _TracLinks: https://trac.edgewall.org/wiki/TracLinks +.. _OmegaT: https://omegat.org/ .. _PlantUML: http://plantuml.com/ -.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/ +.. _PyEnchant: https://pythonhosted.org/pyenchant/ .. _sadisplay: https://bitbucket.org/estin/sadisplay/wiki/Home .. _blockdiag: http://blockdiag.com/en/ .. _seqdiag: http://blockdiag.com/en/ .. _actdiag: http://blockdiag.com/en/ .. _nwdiag: http://blockdiag.com/en/ -.. _Google Analytics: http://www.google.com/analytics/ +.. _Google Analytics: https://www.google.com/analytics/ .. _Google Chart: https://developers.google.com/chart/ .. _Google Maps: https://www.google.com/maps .. _Google style: https://google.github.io/styleguide/pyguide.html .. _NumPy style: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt .. _hyphenator: https://github.com/mnater/hyphenator -.. _exceltable: http://pythonhosted.org/sphinxcontrib-exceltable/ +.. _exceltable: https://pythonhosted.org/sphinxcontrib-exceltable/ .. _YouTube: http://www.youtube.com/ -.. _ClearQuest: http://www-03.ibm.com/software/products/en/clearquest -.. _Zope interfaces: http://docs.zope.org/zope.interface/README.html -.. _slideshare: http://www.slideshare.net/ +.. _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/ .. _TikZ/PGF LaTeX package: https://sourceforge.net/projects/pgf/ -.. _MATLAB: http://www.mathworks.com/products/matlab/ +.. _MATLAB: https://www.mathworks.com/products/matlab.html .. _swf: https://bitbucket.org/klorenz/sphinxcontrib-swf .. _findanything: https://bitbucket.org/klorenz/sphinxcontrib-findanything .. _cmakedomain: https://bitbucket.org/klorenz/sphinxcontrib-cmakedomain -.. _GNU Make: http://www.gnu.org/software/make/ +.. _GNU Make: https://www.gnu.org/software/make/ .. _makedomain: https://bitbucket.org/klorenz/sphinxcontrib-makedomain .. _inlinesyntaxhighlight: https://sphinxcontrib-inlinesyntaxhighlight.readthedocs.io/ .. _CMake: https://cmake.org diff --git a/doc/ext/example_google.py b/doc/ext/example_google.py index 5b4fa58df..4f6abacdf 100644 --- a/doc/ext/example_google.py +++ b/doc/ext/example_google.py @@ -29,7 +29,7 @@ Todo: * You have to also use ``sphinx.ext.todo`` extension .. _Google Python Style Guide: - http://google.github.io/styleguide/pyguide.html + https://google.github.io/styleguide/pyguide.html """ diff --git a/doc/ext/graphviz.rst b/doc/ext/graphviz.rst index ef0483da7..8b9fff90b 100644 --- a/doc/ext/graphviz.rst +++ b/doc/ext/graphviz.rst @@ -8,7 +8,7 @@ .. versionadded:: 0.6 -This extension allows you to embed `Graphviz `_ graphs in +This extension allows you to embed `Graphviz `_ graphs in your documents. It adds these directives: diff --git a/doc/ext/linkcode.rst b/doc/ext/linkcode.rst index 05d2cc6db..f00345fca 100644 --- a/doc/ext/linkcode.rst +++ b/doc/ext/linkcode.rst @@ -44,4 +44,4 @@ function that returns an URL based on the object. if not info['module']: return None filename = info['module'].replace('.', '/') - return "http://somesite/sourcerepo/%s.py" % filename + return "https://somesite/sourcerepo/%s.py" % filename diff --git a/doc/ext/math.rst b/doc/ext/math.rst index 4097bb29e..3e4f94c6c 100644 --- a/doc/ext/math.rst +++ b/doc/ext/math.rst @@ -248,7 +248,7 @@ Sphinx. __ https://cdjns.com - __ http://docs.mathjax.org/en/latest/start.html + __ https://docs.mathjax.org/en/latest/start.html The path can be absolute or relative; if it is relative, it is relative to the ``_static`` directory of the built docs. @@ -258,7 +258,7 @@ Sphinx. documentation set on one server, it is advisable to install MathJax in a shared location. - You can also give a full ``http://`` URL different from the CDN URL. + You can also give a full ``https://`` URL different from the CDN URL. :mod:`sphinx.ext.jsmath` -- Render math via JavaScript @@ -284,9 +284,9 @@ package jsMath_. It provides this config value: a shared location. -.. _dvipng: http://savannah.nongnu.org/projects/dvipng/ +.. _dvipng: https://savannah.nongnu.org/projects/dvipng/ .. _dvisvgm: http://dvisvgm.bplaced.net/ .. _MathJax: https://www.mathjax.org/ .. _jsMath: http://www.math.union.edu/~dpvc/jsmath/ -.. _preview-latex package: http://www.gnu.org/software/auctex/preview-latex.html -.. _AmSMath LaTeX package: http://www.ams.org/publications/authors/tex/amslatex +.. _preview-latex package: https://www.gnu.org/software/auctex/preview-latex.html +.. _AmSMath LaTeX package: https://www.ams.org/publications/authors/tex/amslatex diff --git a/doc/ext/napoleon.rst b/doc/ext/napoleon.rst index f7e9081f7..870c2454d 100644 --- a/doc/ext/napoleon.rst +++ b/doc/ext/napoleon.rst @@ -52,9 +52,9 @@ source code files. .. _ReStructuredText: http://docutils.sourceforge.net/rst.html .. _docstrings: https://www.python.org/dev/peps/pep-0287/ .. _Google Python Style Guide: - http://google.github.io/styleguide/pyguide.html + https://google.github.io/styleguide/pyguide.html .. _Google: - http://google.github.io/styleguide/pyguide.html#Comments + https://google.github.io/styleguide/pyguide.html#Comments .. _NumPy: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt .. _Khan Academy: @@ -267,7 +267,7 @@ sure that "sphinx.ext.napoleon" is enabled in `conf.py`:: napoleon_use_rtype = True .. _Google style: - http://google-styleguide.googlecode.com/svn/trunk/pyguide.html + https://google.github.io/styleguide/pyguide.html .. _NumPy style: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt diff --git a/doc/faq.rst b/doc/faq.rst index fe3173749..6643b18c8 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -77,7 +77,7 @@ PyPI Jannis Leidel wrote a `setuptools command `_ that automatically uploads Sphinx documentation to the PyPI package documentation area at - http://pythonhosted.org/. + https://pythonhosted.org/. GitHub Pages Directories starting with underscores are ignored by default which breaks @@ -106,7 +106,7 @@ Google Analytics {% block footer %} {{ super() }} -
This page uses +
This page uses Google Analytics to collect statistics. You can disable it by blocking the JavaScript coming from www.google-analytics.com.