diff options
author | Georg Brandl <georg@python.org> | 2016-02-13 16:00:42 +0100 |
---|---|---|
committer | Georg Brandl <georg@python.org> | 2016-02-13 16:00:46 +0100 |
commit | 5e8642983b27ada2e7f94df6c97c113f59befb3f (patch) | |
tree | 79a5d6ce70d0d5283569519cc33f09ce378e0abc | |
parent | 56a4e791d61fafa88e3a2c3c312504a75a5011ef (diff) | |
download | sphinx-git-5e8642983b27ada2e7f94df6c97c113f59befb3f.tar.gz |
Fixup links in the documentation.
-rw-r--r-- | CHANGES | 2 | ||||
-rw-r--r-- | EXAMPLES | 62 | ||||
-rw-r--r-- | doc/_templates/index.html | 4 | ||||
-rw-r--r-- | doc/builders.rst | 8 | ||||
-rw-r--r-- | doc/config.rst | 2 | ||||
-rw-r--r-- | doc/develop.rst | 26 | ||||
-rw-r--r-- | doc/ext/autodoc.rst | 2 | ||||
-rw-r--r-- | doc/ext/math.rst | 2 | ||||
-rw-r--r-- | doc/ext/napoleon.rst | 2 | ||||
-rw-r--r-- | doc/extdev/markupapi.rst | 2 | ||||
-rw-r--r-- | doc/extensions.rst | 2 | ||||
-rw-r--r-- | doc/faq.rst | 14 | ||||
-rw-r--r-- | doc/install.rst | 2 | ||||
-rw-r--r-- | doc/intl.rst | 4 | ||||
-rw-r--r-- | doc/intro.rst | 12 | ||||
-rw-r--r-- | doc/markup/misc.rst | 2 | ||||
-rw-r--r-- | doc/theming.rst | 8 |
17 files changed, 75 insertions, 81 deletions
@@ -348,7 +348,7 @@ Incompatible changes * Dependency requirement updates: docutils 0.11, Pygments 2.0 * The ``gettext_enables`` config value has been renamed to `gettext_additional_targets`. -* #1735: Use https://doc.python.org/ instead of ``http`` protocol. +* #1735: Use https://docs.python.org/ instead of ``http`` protocol. It was used for `sphinx.ext.intersphinx` and some documentation. Features added @@ -4,7 +4,7 @@ Projects using Sphinx This is an (incomplete) alphabetic list of projects that use Sphinx or are experimenting with using it for their documentation. If you like to be included, please mail to `the Google group -<https://groups.google.com/group/sphinx-users>`_. +<https://groups.google.com/forum/#!forum/sphinx-users>`_. I've grouped the list into sections to make it easier to find interesting examples. @@ -15,11 +15,11 @@ Documentation using the default theme * APSW: http://apidoc.apsw.googlecode.com/hg/index.html * ASE: https://wiki.fysik.dtu.dk/ase/ * Calibre: http://manual.calibre-ebook.com/ -* CodePy: http://documen.tician.de/codepy/ +* CodePy: https://documen.tician.de/codepy/ * Cython: http://docs.cython.org/ * Cormoran: http://cormoran.nhopkg.org/docs/ * Director: http://pythonhosted.org/director/ -* Dirigible: http://www.projectdirigible.com/documentation/ +* Dirigible: http://www.projectdirigible.com/ * F2py: http://f2py.sourceforge.net/docs/ * GeoDjango: https://docs.djangoproject.com/en/dev/ref/contrib/gis/ * Genomedata: @@ -31,10 +31,10 @@ Documentation using the default theme * Heapkeeper: http://heapkeeper.org/ * Hands-on Python Tutorial: http://anh.cs.luc.edu/python/hands-on/3.1/handsonHtml/ -* Hedge: http://documen.tician.de/hedge/ +* Hedge: https://documen.tician.de/hedge/ * Leo: http://leoeditor.com/ -* Lino: http://lino.saffre-rumma.net/ -* MeshPy: http://documen.tician.de/meshpy/ +* Lino: http://www.lino-framework.org/ +* MeshPy: https://documen.tician.de/meshpy/ * mpmath: http://mpmath.googlecode.com/svn/trunk/doc/build/index.html * OpenEXR: http://excamera.com/articles/26/doc/index.html * OpenGDA: http://www.opengda.org/gdadoc/html/ @@ -42,17 +42,17 @@ Documentation using the default theme * Paste: http://pythonpaste.org/script/ * Paver: http://paver.github.io/paver/ * Pioneers and Prominent Men of Utah: http://pioneers.rstebbing.com/ -* PyCantonese: http://pycantonese.github.io/ +* PyCantonese: http://pycantonese.org/ * Pyccuracy: https://github.com/heynemann/pyccuracy/wiki/ -* PyCuda: http://documen.tician.de/pycuda/ +* PyCuda: https://documen.tician.de/pycuda/ * Pyevolve: http://pyevolve.sourceforge.net/ -* Pylo: http://documen.tician.de/pylo/ +* Pylo: https://documen.tician.de/pylo/ * PyMQI: http://pythonhosted.org/pymqi/ * PyPubSub: http://pubsub.sourceforge.net/ * pySPACE: http://pyspace.github.io/pyspace/ -* Python: https://docs.python.org/ +* Python: https://docs.python.org/3/ * python-apt: http://apt.alioth.debian.org/python-apt-doc/ -* PyUblas: http://documen.tician.de/pyublas/ +* PyUblas: https://documen.tician.de/pyublas/ * Quex: http://quex.sourceforge.net/doc/html/main.html * Scapy: http://www.secdev.org/projects/scapy/doc/ * Segway: http://noble.gs.washington.edu/proj/segway/doc/1.1.0/segway.html @@ -78,7 +78,6 @@ Documentation using a customized version of the default theme https://or-tools.googlecode.com/svn/trunk/documentation/user_manual/index.html * GPAW: https://wiki.fysik.dtu.dk/gpaw/ * Grok: http://grok.zope.org/doc/current/ -* IFM: http://fluffybunny.memebot.com/ifm-docs/index.html * Kaa: http://api.freevo.org/kaa-base/ * LEPL: http://www.acooke.org/lepl/ * Mayavi: http://docs.enthought.com/mayavi/mayavi/ @@ -87,11 +86,11 @@ Documentation using a customized version of the default theme * NumPy: http://docs.scipy.org/doc/numpy/reference/ * OpenCV: http://docs.opencv.org/ * Peach^3: http://peach3.nl/doc/latest/userdoc/ -* Sage: http://sagemath.org/doc/ +* Sage: http://www.sagemath.org/doc/ * SciPy: http://docs.scipy.org/doc/scipy/reference/ * simuPOP: http://simupop.sourceforge.net/manual_release/build/userGuide.html * Sprox: http://sprox.org/ -* TurboGears: http://turbogears.org/2.0/docs/ +* TurboGears: http://turbogears.readthedocs.org/en/latest/ * Varnish: https://www.varnish-cache.org/docs/ * Zentyal: http://doc.zentyal.org/ * Zope: http://docs.zope.org/zope2/index.html @@ -114,9 +113,8 @@ Documentation using the sphinxdoc theme * Python Wild Magic: http://vmlaker.github.io/pythonwildmagic/ * Reteisi: http://www.reteisi.org/contents.html * Sqlkit: http://sqlkit.argolinux.org/ -* Tau: http://www.tango-controls.org/static/tau/latest/doc/html/index.html * Turbulenz: http://docs.turbulenz.com/ -* WebFaction: http://docs.webfaction.com/ +* WebFaction: https://docs.webfaction.com/ Documentation using another builtin theme @@ -145,12 +143,12 @@ Documentation using another builtin theme Documentation using a custom theme/integrated in a site ------------------------------------------------------- -* Blender: http://www.blender.org/documentation/250PythonDoc/ +* Blender: https://www.blender.org/api/250PythonDoc/ * Blinker: http://discorporate.us/projects/Blinker/docs/ -* Ceph: http://ceph.com/docs/master/ +* Ceph: http://docs.ceph.com/docs/master/ * Classy: http://www.pocoo.org/projects/classy/ * DEAP: http://deap.gel.ulaval.ca/doc/0.8/index.html -* Django: http://docs.djangoproject.com/ +* Django: https://docs.djangoproject.com/ * Elemental: http://libelemental.org/documentation/dev/index.html * Enterprise Toolkit for Acrobat products: http://www.adobe.com/devnet-docs/acrobatetk/ @@ -160,33 +158,31 @@ Documentation using a custom theme/integrated in a site * Gameduino: http://excamera.com/sphinx/gameduino/ * GeoServer: http://docs.geoserver.org/ * Glashammer: http://glashammer.org/ -* Istihza (Turkish Python documentation project): - http://www.istihza.com/py2/icindekiler_python.html +* Istihza (Turkish Python documentation project): http://belgeler.istihza.com/py2/ * Lasso: http://lassoguide.com/ * Manage documentation such as source code (fr): http://redaction-technique.org/ * MathJax: http://docs.mathjax.org/en/latest/ * MirrorBrain: http://mirrorbrain.org/docs/ * MyHDL: http://docs.myhdl.org/en/latest/ * nose: http://nose.readthedocs.org/en/latest/ -* NoTex: https://notex.ch/overview/ +* NoTex: https://www.notex.ch/overview/ * ObjectListView: http://objectlistview.sourceforge.net/python/ -* Open ERP: http://doc.openerp.com/ +* Open ERP: https://doc.odoo.com/ * OpenCV: http://docs.opencv.org/ -* Open Dylan: http://opendylan.org/documentation/ and also provides a - `dylan domain <https://github.com/dylan-lang/sphinx-extensions/blob/master/dylandomain/reference.rst>`__ +* Open Dylan: http://opendylan.org/documentation/ * OpenLayers: http://docs.openlayers.org/ * PyEphem: http://rhodesmill.org/pyephem/ * German Plone user manual: http://www.hasecke.com/plone-benutzerhandbuch/ -* PSI4: http://sirius.chem.vt.edu/psi4manual/latest/index.html +* PSI4: http://www.psicode.org/psi4manual/master/index.html * Pylons: http://docs.pylonsproject.org/projects/pylons-webframework/en/latest/ -* PyMOTW: http://pymotw.com/2/ +* PyMOTW: https://pymotw.com/2/ * python-aspectlib: http://python-aspectlib.readthedocs.org/en/latest/ (`sphinx-py3doc-enhanced-theme`_) * QGIS: http://qgis.org/en/docs/index.html * qooxdoo: http://manual.qooxdoo.org/current/ * Roundup: http://www.roundup-tracker.org/ * Selenium: http://docs.seleniumhq.org/docs/ -* Self: http://selflanguage.org/ +* Self: http://www.selflanguage.org/ * Substance D: http://docs.pylonsproject.org/projects/substanced/en/latest/ * Tablib: http://tablib.org/ * SQLAlchemy: http://www.sqlalchemy.org/docs/ @@ -201,14 +197,12 @@ Documentation using a custom theme/integrated in a site Homepages and other non-documentation sites ------------------------------------------- -* Applied Mathematics at the Stellenbosch University: http://dip.sun.ac.za/ * A personal page: http://www.dehlia.in/ * Benoit Boissinot: http://bboissin.appspot.com/ * lunarsite: http://lunaryorn.de/ -* Red Hot Chili Python: http://redhotchilipython.com/ * The Wine Cellar Book: http://www.thewinecellarbook.com/doc/en/ * UC Berkeley Advanced Control Systems course: - http://www.me.berkeley.edu/ME233/sp14/ + http://msc.berkeley.edu/tomizuka/me233spring13/ * VOR: http://www.vor-cycling.be/ @@ -217,11 +211,11 @@ Books produced using Sphinx * "The ``repoze.bfg`` Web Application Framework": http://www.amazon.com/repoze-bfg-Web-Application-Framework-Version/dp/0615345379 -* A Theoretical Physics Reference book: http://theoretical-physics.net/ +* A Theoretical Physics Reference book: http://www.theoretical-physics.net/ * "Simple and Steady Way of Learning for Software Engineering" (in Japanese): http://www.amazon.co.jp/dp/477414259X/ * "Expert Python Programming": - http://www.packtpub.com/expert-python-programming/book + https://www.packtpub.com/application-development/expert-python-programming * "Expert Python Programming" (Japanese translation): http://www.amazon.co.jp/dp/4048686291/ * "Pomodoro Technique Illustrated" (Japanese translation): @@ -231,7 +225,7 @@ Books produced using Sphinx * "Die Wahrheit des Sehens. Der DEKALOG von Krzysztof KieÅ›lowski": http://www.hasecke.eu/Dekalog/ * The "Varnish Book": - https://www.varnish-software.com/static/book/ + http://book.varnish-software.com/4.0/ * "Learning Sphinx" (in Japanese): http://www.oreilly.co.jp/books/9784873116488/ * "LassoGuide": diff --git a/doc/_templates/index.html b/doc/_templates/index.html index 4c23114db..30373f06b 100644 --- a/doc/_templates/index.html +++ b/doc/_templates/index.html @@ -39,10 +39,10 @@ in a second repository; most of them installable from PyPI{%endtrans%}</li> </ul> <p>{%trans%} - Sphinx uses <a href="http://docutils.sf.net/rst.html">reStructuredText</a> + Sphinx uses <a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a> as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating - suite, the <a href="http://docutils.sf.net/">Docutils</a>.{%endtrans%} + suite, the <a href="http://docutils.sourceforge.net/">Docutils</a>.{%endtrans%} </p> <h2 style="margin-bottom: 0">{%trans%}Documentation{%endtrans%}</h2> diff --git a/doc/builders.rst b/doc/builders.rst index cc9c9f3e8..be73b3029 100644 --- a/doc/builders.rst +++ b/doc/builders.rst @@ -84,7 +84,7 @@ The builder's "name" must be given to the **-b** command-line option of .. autoattribute:: supported_image_types - .. _Qt help: http://qt-project.org/doc/qt-4.8/qthelp-framework.html + .. _Qt help: http://doc.qt.io/qt-4.8/qthelp-framework.html .. module:: sphinx.builders.applehelp .. class:: AppleHelpBuilder @@ -131,7 +131,7 @@ The builder's "name" must be given to the **-b** command-line option of 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 - `<http://idpf.org/epub>`_ or `<http://en.wikipedia.org/wiki/EPUB>`_. + `<http://idpf.org/epub>`_ or `<https://en.wikipedia.org/wiki/EPUB>`_. The builder creates *EPUB 2* files. .. autoattribute:: name @@ -146,7 +146,7 @@ The builder's "name" must be given to the **-b** command-line option of 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 - `<http://idpf.org/epub>`_ or `<http://en.wikipedia.org/wiki/EPUB>`_. + `<http://idpf.org/epub>`_ or `<https://en.wikipedia.org/wiki/EPUB>`_. The builder creates *EPUB 3* files. This builder is still *experimental* because it can't generate valid EPUB 3 @@ -186,7 +186,7 @@ The builder's "name" must be given to the **-b** command-line option of .. autoattribute:: supported_image_types Note that a direct PDF builder using ReportLab is available in `rst2pdf -<http://rst2pdf.googlecode.com>`_ version 0.12 or greater. You need to add +<https://github.com/rst2pdf/rst2pdf>`_ version 0.12 or greater. You need to add ``'rst2pdf.pdfbuilder'`` to your :confval:`extensions` to enable it, its name is ``pdf``. Refer to the `rst2pdf manual <http://ralsina.me/static/manual.pdf>`_ for details. diff --git a/doc/config.rst b/doc/config.rst index 63f43998a..38e4603ab 100644 --- a/doc/config.rst +++ b/doc/config.rst @@ -791,7 +791,7 @@ that use Sphinx's HTMLWriter class. .. confval:: html_use_opensearch - If nonempty, an `OpenSearch <http://opensearch.org>`_ description file will be + If nonempty, an `OpenSearch <http://www.opensearch.org/Home>`_ description file will be output, and all pages will contain a ``<link>`` tag referring to it. Since OpenSearch doesn't support relative URLs for its search page location, the value of this option must be the base URL from which these documents are diff --git a/doc/develop.rst b/doc/develop.rst index bc6842eb9..f2f336cfa 100644 --- a/doc/develop.rst +++ b/doc/develop.rst @@ -10,7 +10,7 @@ Sphinx is a maintained by a group of volunteers. We value every contribution! * Issues and feature requests should be raised in the `tracker <https://github.com/sphinx-doc/sphinx/issues>`_. * The mailing list for development is at `Google Groups - <https://groups.google.com/group/sphinx-dev/>`_. + <https://groups.google.com/forum/#!forum/sphinx-dev>`_. * There is also the #sphinx-doc IRC channel on `freenode <http://freenode.net/>`_. @@ -21,7 +21,7 @@ Extensions To learn how to write your own extension, see :ref:`dev-extensions`. -The `sphinx-contrib <http://bitbucket.org/birkenfeld/sphinx-contrib/>`_ +The `sphinx-contrib <https://bitbucket.org/birkenfeld/sphinx-contrib/>`_ repository contains many contributed extensions. Some of them have their own releases on PyPI, others you can install from a checkout. @@ -96,14 +96,14 @@ own extensions. .. _aafigure: https://launchpad.net/aafigure .. _gnuplot: http://www.gnuplot.info/ -.. _paver: http://www.blueskyonmars.com/projects/paver/ +.. _paver: http://paver.github.io/paver/ .. _Sword: http://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/ -.. _PlantUML: http://plantuml.sourceforge.net/ +.. _PlantUML: http://plantuml.com/ .. _PyEnchant: http://www.rfk.id.au/software/pyenchant/ .. _sadisplay: https://bitbucket.org/estin/sadisplay/wiki/Home .. _blockdiag: http://blockdiag.com/en/ @@ -112,24 +112,24 @@ own extensions. .. _nwdiag: http://blockdiag.com/en/ .. _Google Analytics: http://www.google.com/analytics/ .. _Google Chart: https://developers.google.com/chart/ -.. _Google Maps: https://maps.google.com/ +.. _Google Maps: https://www.google.com/maps .. _Google style: http://google-styleguide.googlecode.com/svn/trunk/pyguide.html .. _NumPy style: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt -.. _hyphenator: http://code.google.com/p/hyphenator/ +.. _hyphenator: https://github.com/mnater/hyphenator .. _exceltable: http://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/ -.. _TikZ/PGF LaTeX package: http://sourceforge.net/projects/pgf/ +.. _TikZ/PGF LaTeX package: https://sourceforge.net/projects/pgf/ .. _MATLAB: http://www.mathworks.com/products/matlab/ -.. _swf: http://bitbucket.org/klorenz/sphinxcontrib-swf -.. _findanything: http://bitbucket.org/klorenz/sphinxcontrib-findanything -.. _cmakedomain: http://bitbucket.org/klorenz/sphinxcontrib-cmakedomain +.. _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/ -.. _makedomain: http://bitbucket.org/klorenz/sphinxcontrib-makedomain +.. _makedomain: https://bitbucket.org/klorenz/sphinxcontrib-makedomain .. _inlinesyntaxhighlight: http://sphinxcontrib-inlinesyntaxhighlight.readthedocs.org -.. _CMake: http://cmake.org -.. _domaintools: http://bitbucket.org/klorenz/sphinxcontrib-domaintools +.. _CMake: https://cmake.org +.. _domaintools: https://bitbucket.org/klorenz/sphinxcontrib-domaintools .. _restbuilder: https://pypi.python.org/pypi/sphinxcontrib-restbuilder .. _Lasso: http://www.lassosoft.com/ diff --git a/doc/ext/autodoc.rst b/doc/ext/autodoc.rst index 844c63684..a73e500a9 100644 --- a/doc/ext/autodoc.rst +++ b/doc/ext/autodoc.rst @@ -41,7 +41,7 @@ you can also enable the :mod:`napoleon <sphinx.ext.napoleon>` extension. docstrings to correct reStructuredText before :mod:`autodoc` processes them. .. _Google: - http://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments + https://google.github.io/styleguide/pyguide.html#Comments .. _NumPy: https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt diff --git a/doc/ext/math.rst b/doc/ext/math.rst index 61fa0ca83..56a44a217 100644 --- a/doc/ext/math.rst +++ b/doc/ext/math.rst @@ -265,7 +265,7 @@ package jsMath_. It provides this config value: .. _dvipng: http://savannah.nongnu.org/projects/dvipng/ .. _dvisvgm: http://dvisvgm.bplaced.net/ -.. _MathJax: http://www.mathjax.org/ +.. _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 diff --git a/doc/ext/napoleon.rst b/doc/ext/napoleon.rst index fed6187f3..1531a3f27 100644 --- a/doc/ext/napoleon.rst +++ b/doc/ext/napoleon.rst @@ -48,7 +48,7 @@ the documentation, so it doesn't modify any of the docstrings in your actual source code files. .. _ReStructuredText: http://docutils.sourceforge.net/rst.html -.. _docstrings: http://www.python.org/dev/peps/pep-0287/ +.. _docstrings: https://www.python.org/dev/peps/pep-0287/ .. _Google Python Style Guide: http://google.github.io/styleguide/pyguide.html .. _Google: diff --git a/doc/extdev/markupapi.rst b/doc/extdev/markupapi.rst index 577a39e0d..99a1ae9fb 100644 --- a/doc/extdev/markupapi.rst +++ b/doc/extdev/markupapi.rst @@ -135,5 +135,5 @@ return ``node.children`` from the Directive. .. seealso:: - `Creating directives <http://docutils.sf.net/docs/howto/rst-directives.html>`_ + `Creating directives <http://docutils.sourceforge.net/docs/howto/rst-directives.html>`_ HOWTO of the Docutils documentation diff --git a/doc/extensions.rst b/doc/extensions.rst index 47632e593..41243d5e8 100644 --- a/doc/extensions.rst +++ b/doc/extensions.rst @@ -48,7 +48,7 @@ comprehensive list. If you write an extension that you think others will find useful or you think should be included as a part of Sphinx, please write to the project mailing -list (`join here <https://groups.google.com/group/sphinx-dev>`_). +list (`join here <https://groups.google.com/forum/#!forum/sphinx-dev>`_). .. _Sphinx Contrib: https://bitbucket.org/birkenfeld/sphinx-contrib diff --git a/doc/faq.rst b/doc/faq.rst index 7a49aed63..313f1d034 100644 --- a/doc/faq.rst +++ b/doc/faq.rst @@ -10,7 +10,7 @@ How do I... ----------- ... create PDF files without LaTeX? - You can use `rst2pdf <http://rst2pdf.googlecode.com>`_ version 0.12 or + You can use `rst2pdf <https://github.com/rst2pdf/rst2pdf>`_ version 0.12 or greater which comes with built-in Sphinx integration. See the :ref:`builders` section for details. @@ -82,7 +82,7 @@ GitHub Pages Sphinx HTML output properly. MediaWiki - See https://bitbucket.org/kevindunn/sphinx-wiki, a project by Kevin Dunn. + See https://bitbucket.org/kevindunn/sphinx-wiki/wiki/Home, a project by Kevin Dunn. Google Analytics You can use a custom ``layout.html`` template, like this: @@ -140,7 +140,7 @@ The following list gives some hints for the creation of epub files: are often cut at the right margin. The default Courier font (or variant) is quite wide and you can only display up to 60 characters on a line. If you replace it with a narrower font, you can get more characters on a line. You - may even use `FontForge <http://fontforge.org/>`_ and create + may even use `FontForge <http://fontforge.github.io/>`_ and create narrow variants of some free font. In my case I get up to 70 characters on a line. @@ -149,7 +149,7 @@ The following list gives some hints for the creation of epub files: * Test the created epubs. You can use several alternatives. The ones I am aware of are Epubcheck_, Calibre_, FBreader_ (although it does not render the CSS), and Bookworm_. For bookworm you can download the source from - http://code.google.com/p/threepress/ and run your own local server. + https://code.google.com/archive/p/threepress and run your own local server. * Large floating divs are not displayed properly. If they cover more than one page, the div is only shown on the first page. @@ -167,10 +167,10 @@ The following list gives some hints for the creation of epub files: :confval:`html_static_path` directory and reference it with its full path in the :confval:`epub_cover` config option. -.. _Epubcheck: http://code.google.com/p/epubcheck/ +.. _Epubcheck: https://code.google.com/archive/p/epubcheck .. _Calibre: http://calibre-ebook.com/ -.. _FBreader: http://fbreader.org/ -.. _Bookworm: http://oreilly.com/bookworm/index.html +.. _FBreader: https://fbreader.org/ +.. _Bookworm: http://www.oreilly.com/bookworm/index.html .. _texinfo-faq: diff --git a/doc/install.rst b/doc/install.rst index dda034843..0ecd73609 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -72,7 +72,7 @@ Install Python Most Windows users do not have Python, so we begin with the installation of Python itself. If you have already installed Python, please skip this section. -Go to http://python.org, the main download site for Python. Look at the left +Go to https://www.python.org/, the main download site for Python. Look at the left sidebar and under "Quick Links", click "Windows Installer" to download. .. image:: pythonorg.png diff --git a/doc/intl.rst b/doc/intl.rst index 2290b0fde..cbcc0a374 100644 --- a/doc/intl.rst +++ b/doc/intl.rst @@ -302,5 +302,5 @@ There is `sphinx translation page`_ for Sphinx-1.3 documentation. .. _`transifex-client`: https://pypi.python.org/pypi/transifex-client .. _`sphinx-intl`: https://pypi.python.org/pypi/sphinx-intl .. _Transifex: https://www.transifex.com/ -.. _`sphinx translation page`: https://www.transifex.com/projects/p/sphinx-doc-1_3/ -.. _`Transifex Client v0.8 — Transifex documentation`: http://help.transifex.com/features/client/index.html +.. _`sphinx translation page`: https://www.transifex.com/sphinx-doc/sphinx-doc-1_3/ +.. _`Transifex Client v0.8 — Transifex documentation`: http://docs.transifex.com/developer/client/ diff --git a/doc/intro.rst b/doc/intro.rst index 44c57529c..ae3ec0b33 100644 --- a/doc/intro.rst +++ b/doc/intro.rst @@ -9,12 +9,12 @@ possibly subdirectories of docs in there as well), Sphinx can generate a nicely-organized arrangement of HTML files (in some other directory) for easy browsing and navigation. But from the same source, it can also generate a LaTeX file that you can compile into a PDF version of the documents, or a -PDF file directly using `rst2pdf <http://rst2pdf.googlecode.com>`_. +PDF file directly using `rst2pdf <https://github.com/rst2pdf/rst2pdf>`_. The focus is on hand-written documentation, rather than auto-generated API docs. Though there is support for that kind of docs as well (which is intended to be freely mixed with hand-written content), if you need pure API docs have a look -at `Epydoc <http://epydoc.sf.net/>`_, which also understands reST. +at `Epydoc <http://epydoc.sourceforge.net/>`_, which also understands reST. For a great "introduction" to writing docs in general -- the whys and hows, see also `Write the docs <http://write-the-docs.readthedocs.org/>`_, written by Eric @@ -36,12 +36,12 @@ to reStructuredText/Sphinx from other documentation systems. code to convert Python-doc-style LaTeX markup to Sphinx reST. * Marcin Wojdyr has written a script to convert Docbook to reST with Sphinx - markup; it is at `Google Code <http://code.google.com/p/db2rst/>`_. + markup; it is at `Google Code <https://github.com/wojdyr/db2rst>`_. * Christophe de Vienne wrote a tool to convert from Open/LibreOffice documents to Sphinx: `odt2sphinx <https://pypi.python.org/pypi/odt2sphinx/>`_. -* To convert different markups, `Pandoc <http://johnmacfarlane.net/pandoc/>`_ is +* To convert different markups, `Pandoc <http://pandoc.org/>`_ is a very helpful tool. @@ -59,8 +59,8 @@ docutils_ and Jinja2_ libraries. Sphinx should work with docutils version 0.10 or some (not broken) SVN trunk snapshot. If you like to have source code highlighting support, you must also install the Pygments_ library. -.. _reStructuredText: http://docutils.sf.net/rst.html -.. _docutils: http://docutils.sf.net/ +.. _reStructuredText: http://docutils.sourceforge.net/rst.html +.. _docutils: http://docutils.sourceforge.net/ .. _Jinja2: http://jinja.pocoo.org/ .. _Pygments: http://pygments.org/ diff --git a/doc/markup/misc.rst b/doc/markup/misc.rst index 2855f1fad..1f9f446f1 100644 --- a/doc/markup/misc.rst +++ b/doc/markup/misc.rst @@ -191,7 +191,7 @@ Including content based on tags All tags must follow the standard Python identifier syntax as set out in the `Identifiers and keywords - <https://docs.python.org/reference/lexical_analysis.html#identifiers>`_ + <https://docs.python.org/2/reference/lexical_analysis.html#identifiers>`_ documentation. That is, a tag expression may only consist of tags that conform to the syntax of Python variables. In ASCII, this consists of the uppercase and lowercase letters ``A`` through ``Z``, the underscore ``_`` diff --git a/doc/theming.rst b/doc/theming.rst index 551b02c34..c003c79f8 100644 --- a/doc/theming.rst +++ b/doc/theming.rst @@ -152,9 +152,9 @@ These themes are: .. _Read the Docs Sphinx Theme: https://pypi.python.org/pypi/sphinx_rtd_theme -* **classic** -- This is the classic theme, which looks like `the Python - documentation <https://docs.python.org/>`_. It can be customized via these - options: +* **classic** -- This is the classic theme, which looks like `the Python 2 + documentation <https://docs.python.org/2/>`_. It can be customized via + these options: - **rightsidebar** (true or false): Put the sidebar on the right side. Defaults to ``False``. @@ -240,7 +240,7 @@ These themes are: *sidebarwidth*. * **haiku** -- A theme without sidebar inspired by the `Haiku OS user guide - <http://www.haiku-os.org/docs/userguide/en/contents.html>`_. The following + <https://www.haiku-os.org/docs/userguide/en/contents.html>`_. The following options are supported: - **full_logo** (true or false, default ``False``): If this is true, the |