Fixup links in the documentation.

This commit is contained in:
Georg Brandl
2016-02-13 16:00:46 +01:00
parent 56a4e791d6
commit 5e8642983b
17 changed files with 75 additions and 81 deletions
+1 -1
View File
@@ -348,7 +348,7 @@ Incompatible changes
* Dependency requirement updates: docutils 0.11, Pygments 2.0 * Dependency requirement updates: docutils 0.11, Pygments 2.0
* The ``gettext_enables`` config value has been renamed to * The ``gettext_enables`` config value has been renamed to
`gettext_additional_targets`. `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. It was used for `sphinx.ext.intersphinx` and some documentation.
Features added Features added
+28 -34
View File
@@ -4,7 +4,7 @@ Projects using Sphinx
This is an (incomplete) alphabetic list of projects that use Sphinx or This is an (incomplete) alphabetic list of projects that use Sphinx or
are experimenting with using it for their documentation. If you like to are experimenting with using it for their documentation. If you like to
be included, please mail to `the Google group 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 I've grouped the list into sections to make it easier to find
interesting examples. interesting examples.
@@ -15,11 +15,11 @@ Documentation using the default theme
* APSW: http://apidoc.apsw.googlecode.com/hg/index.html * APSW: http://apidoc.apsw.googlecode.com/hg/index.html
* ASE: https://wiki.fysik.dtu.dk/ase/ * ASE: https://wiki.fysik.dtu.dk/ase/
* Calibre: http://manual.calibre-ebook.com/ * Calibre: http://manual.calibre-ebook.com/
* CodePy: http://documen.tician.de/codepy/ * CodePy: https://documen.tician.de/codepy/
* Cython: http://docs.cython.org/ * Cython: http://docs.cython.org/
* Cormoran: http://cormoran.nhopkg.org/docs/ * Cormoran: http://cormoran.nhopkg.org/docs/
* Director: http://pythonhosted.org/director/ * Director: http://pythonhosted.org/director/
* Dirigible: http://www.projectdirigible.com/documentation/ * Dirigible: http://www.projectdirigible.com/
* F2py: http://f2py.sourceforge.net/docs/ * F2py: http://f2py.sourceforge.net/docs/
* GeoDjango: https://docs.djangoproject.com/en/dev/ref/contrib/gis/ * GeoDjango: https://docs.djangoproject.com/en/dev/ref/contrib/gis/
* Genomedata: * Genomedata:
@@ -31,10 +31,10 @@ Documentation using the default theme
* Heapkeeper: http://heapkeeper.org/ * Heapkeeper: http://heapkeeper.org/
* Hands-on Python Tutorial: * Hands-on Python Tutorial:
http://anh.cs.luc.edu/python/hands-on/3.1/handsonHtml/ 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/ * Leo: http://leoeditor.com/
* Lino: http://lino.saffre-rumma.net/ * Lino: http://www.lino-framework.org/
* MeshPy: http://documen.tician.de/meshpy/ * MeshPy: https://documen.tician.de/meshpy/
* mpmath: http://mpmath.googlecode.com/svn/trunk/doc/build/index.html * mpmath: http://mpmath.googlecode.com/svn/trunk/doc/build/index.html
* OpenEXR: http://excamera.com/articles/26/doc/index.html * OpenEXR: http://excamera.com/articles/26/doc/index.html
* OpenGDA: http://www.opengda.org/gdadoc/html/ * OpenGDA: http://www.opengda.org/gdadoc/html/
@@ -42,17 +42,17 @@ Documentation using the default theme
* Paste: http://pythonpaste.org/script/ * Paste: http://pythonpaste.org/script/
* Paver: http://paver.github.io/paver/ * Paver: http://paver.github.io/paver/
* Pioneers and Prominent Men of Utah: http://pioneers.rstebbing.com/ * 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/ * Pyccuracy: https://github.com/heynemann/pyccuracy/wiki/
* PyCuda: http://documen.tician.de/pycuda/ * PyCuda: https://documen.tician.de/pycuda/
* Pyevolve: http://pyevolve.sourceforge.net/ * Pyevolve: http://pyevolve.sourceforge.net/
* Pylo: http://documen.tician.de/pylo/ * Pylo: https://documen.tician.de/pylo/
* PyMQI: http://pythonhosted.org/pymqi/ * PyMQI: http://pythonhosted.org/pymqi/
* PyPubSub: http://pubsub.sourceforge.net/ * PyPubSub: http://pubsub.sourceforge.net/
* pySPACE: http://pyspace.github.io/pyspace/ * 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/ * 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 * Quex: http://quex.sourceforge.net/doc/html/main.html
* Scapy: http://www.secdev.org/projects/scapy/doc/ * Scapy: http://www.secdev.org/projects/scapy/doc/
* Segway: http://noble.gs.washington.edu/proj/segway/doc/1.1.0/segway.html * 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 https://or-tools.googlecode.com/svn/trunk/documentation/user_manual/index.html
* GPAW: https://wiki.fysik.dtu.dk/gpaw/ * GPAW: https://wiki.fysik.dtu.dk/gpaw/
* Grok: http://grok.zope.org/doc/current/ * Grok: http://grok.zope.org/doc/current/
* IFM: http://fluffybunny.memebot.com/ifm-docs/index.html
* Kaa: http://api.freevo.org/kaa-base/ * Kaa: http://api.freevo.org/kaa-base/
* LEPL: http://www.acooke.org/lepl/ * LEPL: http://www.acooke.org/lepl/
* Mayavi: http://docs.enthought.com/mayavi/mayavi/ * 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/ * NumPy: http://docs.scipy.org/doc/numpy/reference/
* OpenCV: http://docs.opencv.org/ * OpenCV: http://docs.opencv.org/
* Peach^3: http://peach3.nl/doc/latest/userdoc/ * 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/ * SciPy: http://docs.scipy.org/doc/scipy/reference/
* simuPOP: http://simupop.sourceforge.net/manual_release/build/userGuide.html * simuPOP: http://simupop.sourceforge.net/manual_release/build/userGuide.html
* Sprox: http://sprox.org/ * 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/ * Varnish: https://www.varnish-cache.org/docs/
* Zentyal: http://doc.zentyal.org/ * Zentyal: http://doc.zentyal.org/
* Zope: http://docs.zope.org/zope2/index.html * 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/ * Python Wild Magic: http://vmlaker.github.io/pythonwildmagic/
* Reteisi: http://www.reteisi.org/contents.html * Reteisi: http://www.reteisi.org/contents.html
* Sqlkit: http://sqlkit.argolinux.org/ * Sqlkit: http://sqlkit.argolinux.org/
* Tau: http://www.tango-controls.org/static/tau/latest/doc/html/index.html
* Turbulenz: http://docs.turbulenz.com/ * Turbulenz: http://docs.turbulenz.com/
* WebFaction: http://docs.webfaction.com/ * WebFaction: https://docs.webfaction.com/
Documentation using another builtin theme Documentation using another builtin theme
@@ -145,12 +143,12 @@ Documentation using another builtin theme
Documentation using a custom theme/integrated in a site 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/ * 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/ * Classy: http://www.pocoo.org/projects/classy/
* DEAP: http://deap.gel.ulaval.ca/doc/0.8/index.html * 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 * Elemental: http://libelemental.org/documentation/dev/index.html
* Enterprise Toolkit for Acrobat products: * Enterprise Toolkit for Acrobat products:
http://www.adobe.com/devnet-docs/acrobatetk/ 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/ * Gameduino: http://excamera.com/sphinx/gameduino/
* GeoServer: http://docs.geoserver.org/ * GeoServer: http://docs.geoserver.org/
* Glashammer: http://glashammer.org/ * Glashammer: http://glashammer.org/
* Istihza (Turkish Python documentation project): * Istihza (Turkish Python documentation project): http://belgeler.istihza.com/py2/
http://www.istihza.com/py2/icindekiler_python.html
* Lasso: http://lassoguide.com/ * Lasso: http://lassoguide.com/
* Manage documentation such as source code (fr): http://redaction-technique.org/ * Manage documentation such as source code (fr): http://redaction-technique.org/
* MathJax: http://docs.mathjax.org/en/latest/ * MathJax: http://docs.mathjax.org/en/latest/
* MirrorBrain: http://mirrorbrain.org/docs/ * MirrorBrain: http://mirrorbrain.org/docs/
* MyHDL: http://docs.myhdl.org/en/latest/ * MyHDL: http://docs.myhdl.org/en/latest/
* nose: http://nose.readthedocs.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/ * ObjectListView: http://objectlistview.sourceforge.net/python/
* Open ERP: http://doc.openerp.com/ * Open ERP: https://doc.odoo.com/
* OpenCV: http://docs.opencv.org/ * OpenCV: http://docs.opencv.org/
* Open Dylan: http://opendylan.org/documentation/ and also provides a * Open Dylan: http://opendylan.org/documentation/
`dylan domain <https://github.com/dylan-lang/sphinx-extensions/blob/master/dylandomain/reference.rst>`__
* OpenLayers: http://docs.openlayers.org/ * OpenLayers: http://docs.openlayers.org/
* PyEphem: http://rhodesmill.org/pyephem/ * PyEphem: http://rhodesmill.org/pyephem/
* German Plone user manual: http://www.hasecke.com/plone-benutzerhandbuch/ * 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/ * 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/ * python-aspectlib: http://python-aspectlib.readthedocs.org/en/latest/
(`sphinx-py3doc-enhanced-theme`_) (`sphinx-py3doc-enhanced-theme`_)
* QGIS: http://qgis.org/en/docs/index.html * QGIS: http://qgis.org/en/docs/index.html
* qooxdoo: http://manual.qooxdoo.org/current/ * qooxdoo: http://manual.qooxdoo.org/current/
* Roundup: http://www.roundup-tracker.org/ * Roundup: http://www.roundup-tracker.org/
* Selenium: http://docs.seleniumhq.org/docs/ * 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/ * Substance D: http://docs.pylonsproject.org/projects/substanced/en/latest/
* Tablib: http://tablib.org/ * Tablib: http://tablib.org/
* SQLAlchemy: http://www.sqlalchemy.org/docs/ * 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 Homepages and other non-documentation sites
------------------------------------------- -------------------------------------------
* Applied Mathematics at the Stellenbosch University: http://dip.sun.ac.za/
* A personal page: http://www.dehlia.in/ * A personal page: http://www.dehlia.in/
* Benoit Boissinot: http://bboissin.appspot.com/ * Benoit Boissinot: http://bboissin.appspot.com/
* lunarsite: http://lunaryorn.de/ * lunarsite: http://lunaryorn.de/
* Red Hot Chili Python: http://redhotchilipython.com/
* The Wine Cellar Book: http://www.thewinecellarbook.com/doc/en/ * The Wine Cellar Book: http://www.thewinecellarbook.com/doc/en/
* UC Berkeley Advanced Control Systems course: * 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/ * VOR: http://www.vor-cycling.be/
@@ -217,11 +211,11 @@ Books produced using Sphinx
* "The ``repoze.bfg`` Web Application Framework": * "The ``repoze.bfg`` Web Application Framework":
http://www.amazon.com/repoze-bfg-Web-Application-Framework-Version/dp/0615345379 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): * "Simple and Steady Way of Learning for Software Engineering" (in Japanese):
http://www.amazon.co.jp/dp/477414259X/ http://www.amazon.co.jp/dp/477414259X/
* "Expert Python Programming": * "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): * "Expert Python Programming" (Japanese translation):
http://www.amazon.co.jp/dp/4048686291/ http://www.amazon.co.jp/dp/4048686291/
* "Pomodoro Technique Illustrated" (Japanese translation): * "Pomodoro Technique Illustrated" (Japanese translation):
@@ -231,7 +225,7 @@ Books produced using Sphinx
* "Die Wahrheit des Sehens. Der DEKALOG von Krzysztof Kieślowski": * "Die Wahrheit des Sehens. Der DEKALOG von Krzysztof Kieślowski":
http://www.hasecke.eu/Dekalog/ http://www.hasecke.eu/Dekalog/
* The "Varnish Book": * The "Varnish Book":
https://www.varnish-software.com/static/book/ http://book.varnish-software.com/4.0/
* "Learning Sphinx" (in Japanese): * "Learning Sphinx" (in Japanese):
http://www.oreilly.co.jp/books/9784873116488/ http://www.oreilly.co.jp/books/9784873116488/
* "LassoGuide": * "LassoGuide":
+2 -2
View File
@@ -39,10 +39,10 @@
in a second repository; most of them installable from PyPI{%endtrans%}</li> in a second repository; most of them installable from PyPI{%endtrans%}</li>
</ul> </ul>
<p>{%trans%} <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 as its markup language, and many of its strengths come from the power and
straightforwardness of reStructuredText and its parsing and translating 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> </p>
<h2 style="margin-bottom: 0">{%trans%}Documentation{%endtrans%}</h2> <h2 style="margin-bottom: 0">{%trans%}Documentation{%endtrans%}</h2>
+4 -4
View File
@@ -84,7 +84,7 @@ The builder's "name" must be given to the **-b** command-line option of
.. autoattribute:: supported_image_types .. 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 .. module:: sphinx.builders.applehelp
.. class:: AppleHelpBuilder .. 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 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 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 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. The builder creates *EPUB 2* files.
.. autoattribute:: name .. 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 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 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 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. The builder creates *EPUB 3* files.
This builder is still *experimental* because it can't generate valid EPUB 3 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 .. autoattribute:: supported_image_types
Note that a direct PDF builder using ReportLab is available in `rst2pdf 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 ``'rst2pdf.pdfbuilder'`` to your :confval:`extensions` to enable it, its name is
``pdf``. Refer to the `rst2pdf manual <http://ralsina.me/static/manual.pdf>`_ ``pdf``. Refer to the `rst2pdf manual <http://ralsina.me/static/manual.pdf>`_
for details. for details.
+1 -1
View File
@@ -791,7 +791,7 @@ that use Sphinx's HTMLWriter class.
.. confval:: html_use_opensearch .. 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 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 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 value of this option must be the base URL from which these documents are
+13 -13
View File
@@ -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 * Issues and feature requests should be raised in the `tracker
<https://github.com/sphinx-doc/sphinx/issues>`_. <https://github.com/sphinx-doc/sphinx/issues>`_.
* The mailing list for development is at `Google Groups * 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 * There is also the #sphinx-doc IRC channel on `freenode
<http://freenode.net/>`_. <http://freenode.net/>`_.
@@ -21,7 +21,7 @@ Extensions
To learn how to write your own extension, see :ref:`dev-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 repository contains many contributed extensions. Some of them have their own
releases on PyPI, others you can install from a checkout. releases on PyPI, others you can install from a checkout.
@@ -96,14 +96,14 @@ own extensions.
.. _aafigure: https://launchpad.net/aafigure .. _aafigure: https://launchpad.net/aafigure
.. _gnuplot: http://www.gnuplot.info/ .. _gnuplot: http://www.gnuplot.info/
.. _paver: http://www.blueskyonmars.com/projects/paver/ .. _paver: http://paver.github.io/paver/
.. _Sword: http://www.crosswire.org/sword/ .. _Sword: http://www.crosswire.org/sword/
.. _Lilypond: http://lilypond.org/ .. _Lilypond: http://lilypond.org/
.. _sdedit: http://sdedit.sourceforge.net/ .. _sdedit: http://sdedit.sourceforge.net/
.. _Trac: http://trac.edgewall.org .. _Trac: http://trac.edgewall.org
.. _TracLinks: http://trac.edgewall.org/wiki/TracLinks .. _TracLinks: http://trac.edgewall.org/wiki/TracLinks
.. _OmegaT: http://www.omegat.org/ .. _OmegaT: http://www.omegat.org/
.. _PlantUML: http://plantuml.sourceforge.net/ .. _PlantUML: http://plantuml.com/
.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/ .. _PyEnchant: http://www.rfk.id.au/software/pyenchant/
.. _sadisplay: https://bitbucket.org/estin/sadisplay/wiki/Home .. _sadisplay: https://bitbucket.org/estin/sadisplay/wiki/Home
.. _blockdiag: http://blockdiag.com/en/ .. _blockdiag: http://blockdiag.com/en/
@@ -112,24 +112,24 @@ own extensions.
.. _nwdiag: http://blockdiag.com/en/ .. _nwdiag: http://blockdiag.com/en/
.. _Google Analytics: http://www.google.com/analytics/ .. _Google Analytics: http://www.google.com/analytics/
.. _Google Chart: https://developers.google.com/chart/ .. _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 .. _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 .. _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/ .. _exceltable: http://pythonhosted.org/sphinxcontrib-exceltable/
.. _YouTube: http://www.youtube.com/ .. _YouTube: http://www.youtube.com/
.. _ClearQuest: http://www-03.ibm.com/software/products/en/clearquest .. _ClearQuest: http://www-03.ibm.com/software/products/en/clearquest
.. _Zope interfaces: http://docs.zope.org/zope.interface/README.html .. _Zope interfaces: http://docs.zope.org/zope.interface/README.html
.. _slideshare: http://www.slideshare.net/ .. _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/ .. _MATLAB: http://www.mathworks.com/products/matlab/
.. _swf: http://bitbucket.org/klorenz/sphinxcontrib-swf .. _swf: https://bitbucket.org/klorenz/sphinxcontrib-swf
.. _findanything: http://bitbucket.org/klorenz/sphinxcontrib-findanything .. _findanything: https://bitbucket.org/klorenz/sphinxcontrib-findanything
.. _cmakedomain: http://bitbucket.org/klorenz/sphinxcontrib-cmakedomain .. _cmakedomain: https://bitbucket.org/klorenz/sphinxcontrib-cmakedomain
.. _GNU Make: http://www.gnu.org/software/make/ .. _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 .. _inlinesyntaxhighlight: http://sphinxcontrib-inlinesyntaxhighlight.readthedocs.org
.. _CMake: http://cmake.org .. _CMake: https://cmake.org
.. _domaintools: http://bitbucket.org/klorenz/sphinxcontrib-domaintools .. _domaintools: https://bitbucket.org/klorenz/sphinxcontrib-domaintools
.. _restbuilder: https://pypi.python.org/pypi/sphinxcontrib-restbuilder .. _restbuilder: https://pypi.python.org/pypi/sphinxcontrib-restbuilder
.. _Lasso: http://www.lassosoft.com/ .. _Lasso: http://www.lassosoft.com/
+1 -1
View File
@@ -41,7 +41,7 @@ you can also enable the :mod:`napoleon <sphinx.ext.napoleon>` extension.
docstrings to correct reStructuredText before :mod:`autodoc` processes them. docstrings to correct reStructuredText before :mod:`autodoc` processes them.
.. _Google: .. _Google:
http://google-styleguide.googlecode.com/svn/trunk/pyguide.html#Comments https://google.github.io/styleguide/pyguide.html#Comments
.. _NumPy: .. _NumPy:
https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt
+1 -1
View File
@@ -265,7 +265,7 @@ package jsMath_. It provides this config value:
.. _dvipng: http://savannah.nongnu.org/projects/dvipng/ .. _dvipng: http://savannah.nongnu.org/projects/dvipng/
.. _dvisvgm: http://dvisvgm.bplaced.net/ .. _dvisvgm: http://dvisvgm.bplaced.net/
.. _MathJax: http://www.mathjax.org/ .. _MathJax: https://www.mathjax.org/
.. _jsMath: http://www.math.union.edu/~dpvc/jsmath/ .. _jsMath: http://www.math.union.edu/~dpvc/jsmath/
.. _preview-latex package: http://www.gnu.org/software/auctex/preview-latex.html .. _preview-latex package: http://www.gnu.org/software/auctex/preview-latex.html
.. _AmSMath LaTeX package: http://www.ams.org/publications/authors/tex/amslatex .. _AmSMath LaTeX package: http://www.ams.org/publications/authors/tex/amslatex
+1 -1
View File
@@ -48,7 +48,7 @@ the documentation, so it doesn't modify any of the docstrings in your actual
source code files. source code files.
.. _ReStructuredText: http://docutils.sourceforge.net/rst.html .. _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: .. _Google Python Style Guide:
http://google.github.io/styleguide/pyguide.html http://google.github.io/styleguide/pyguide.html
.. _Google: .. _Google:
+1 -1
View File
@@ -135,5 +135,5 @@ return ``node.children`` from the Directive.
.. seealso:: .. 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 HOWTO of the Docutils documentation
+1 -1
View File
@@ -48,7 +48,7 @@ comprehensive list.
If you write an extension that you think others will find useful or you think 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 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 .. _Sphinx Contrib: https://bitbucket.org/birkenfeld/sphinx-contrib
+7 -7
View File
@@ -10,7 +10,7 @@ How do I...
----------- -----------
... create PDF files without LaTeX? ... 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 greater which comes with built-in Sphinx integration. See the
:ref:`builders` section for details. :ref:`builders` section for details.
@@ -82,7 +82,7 @@ GitHub Pages
Sphinx HTML output properly. Sphinx HTML output properly.
MediaWiki 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 Google Analytics
You can use a custom ``layout.html`` template, like this: 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 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 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 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 narrow variants of some free font. In my case I get up to 70 characters on a
line. 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 * 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), of are Epubcheck_, Calibre_, FBreader_ (although it does not render the CSS),
and Bookworm_. For bookworm you can download the source from 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. * Large floating divs are not displayed properly.
If they cover more than one page, the div is only shown on the first page. 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 :confval:`html_static_path` directory and reference it with its full path in
the :confval:`epub_cover` config option. 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/ .. _Calibre: http://calibre-ebook.com/
.. _FBreader: http://fbreader.org/ .. _FBreader: https://fbreader.org/
.. _Bookworm: http://oreilly.com/bookworm/index.html .. _Bookworm: http://www.oreilly.com/bookworm/index.html
.. _texinfo-faq: .. _texinfo-faq:
+1 -1
View File
@@ -72,7 +72,7 @@ Install Python
Most Windows users do not have Python, so we begin with the installation of 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. 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. sidebar and under "Quick Links", click "Windows Installer" to download.
.. image:: pythonorg.png .. image:: pythonorg.png
+2 -2
View File
@@ -302,5 +302,5 @@ There is `sphinx translation page`_ for Sphinx-1.3 documentation.
.. _`transifex-client`: https://pypi.python.org/pypi/transifex-client .. _`transifex-client`: https://pypi.python.org/pypi/transifex-client
.. _`sphinx-intl`: https://pypi.python.org/pypi/sphinx-intl .. _`sphinx-intl`: https://pypi.python.org/pypi/sphinx-intl
.. _Transifex: https://www.transifex.com/ .. _Transifex: https://www.transifex.com/
.. _`sphinx translation page`: https://www.transifex.com/projects/p/sphinx-doc-1_3/ .. _`sphinx translation page`: https://www.transifex.com/sphinx-doc/sphinx-doc-1_3/
.. _`Transifex Client v0.8 &mdash; Transifex documentation`: http://help.transifex.com/features/client/index.html .. _`Transifex Client v0.8 &mdash; Transifex documentation`: http://docs.transifex.com/developer/client/
+6 -6
View File
@@ -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 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 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 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. 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 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 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 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 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. code to convert Python-doc-style LaTeX markup to Sphinx reST.
* Marcin Wojdyr has written a script to convert Docbook to reST with Sphinx * 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 * Christophe de Vienne wrote a tool to convert from Open/LibreOffice documents
to Sphinx: `odt2sphinx <https://pypi.python.org/pypi/odt2sphinx/>`_. 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. 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 or some (not broken) SVN trunk snapshot. If you like to have source code
highlighting support, you must also install the Pygments_ library. highlighting support, you must also install the Pygments_ library.
.. _reStructuredText: http://docutils.sf.net/rst.html .. _reStructuredText: http://docutils.sourceforge.net/rst.html
.. _docutils: http://docutils.sf.net/ .. _docutils: http://docutils.sourceforge.net/
.. _Jinja2: http://jinja.pocoo.org/ .. _Jinja2: http://jinja.pocoo.org/
.. _Pygments: http://pygments.org/ .. _Pygments: http://pygments.org/
+1 -1
View File
@@ -191,7 +191,7 @@ Including content based on tags
All tags must follow the standard Python identifier syntax as set out in All tags must follow the standard Python identifier syntax as set out in
the `Identifiers and keywords 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 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 conform to the syntax of Python variables. In ASCII, this consists of the
uppercase and lowercase letters ``A`` through ``Z``, the underscore ``_`` uppercase and lowercase letters ``A`` through ``Z``, the underscore ``_``
+4 -4
View File
@@ -152,9 +152,9 @@ These themes are:
.. _Read the Docs Sphinx Theme: https://pypi.python.org/pypi/sphinx_rtd_theme .. _Read the Docs Sphinx Theme: https://pypi.python.org/pypi/sphinx_rtd_theme
* **classic** -- This is the classic theme, which looks like `the Python * **classic** -- This is the classic theme, which looks like `the Python 2
documentation <https://docs.python.org/>`_. It can be customized via these documentation <https://docs.python.org/2/>`_. It can be customized via
options: these options:
- **rightsidebar** (true or false): Put the sidebar on the right side. - **rightsidebar** (true or false): Put the sidebar on the right side.
Defaults to ``False``. Defaults to ``False``.
@@ -240,7 +240,7 @@ These themes are:
*sidebarwidth*. *sidebarwidth*.
* **haiku** -- A theme without sidebar inspired by the `Haiku OS user guide * **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: options are supported:
- **full_logo** (true or false, default ``False``): If this is true, the - **full_logo** (true or false, default ``False``): If this is true, the