IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix some broken links

Browse Source
This commit is contained in:
Georg Brandl 2014-01-13 00:05:22 +01:00
parent 5406bff1cd
commit 9708319f5c
11 changed files with 56 additions and 56 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
CHANGES
View File

@ -1124,4 +1124,4 @@ Previous versions
The changelog for versions before 1.0 can be found in the file ``CHANGES.old`` The changelog for versions before 1.0 can be found in the file ``CHANGES.old``
in the source distribution or `at BitBucket in the source distribution or `at BitBucket
<http://bitbucket.org/birkenfeld/sphinx/raw/tip/CHANGES.old>`__. <https://bitbucket.org/birkenfeld/sphinx/raw/tip/CHANGES.old>`__.

6
EXAMPLES
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
<http://groups.google.com/group/sphinx-users>`_. <https://groups.google.com/group/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,12 +15,12 @@ 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/
* boostmpi: http://documen.tician.de/boostmpi/ * boostmpi: http://documen.tician.de/boostmpi/
* Calibre: http://calibre-ebook.com/user_manual/ * Calibre: http://manual.calibre-ebook.com/
* CodePy: http://documen.tician.de/codepy/ * CodePy: http://documen.tician.de/codepy/
* Cython: http://docs.cython.org/ * Cython: http://docs.cython.org/
* C\\C++ Python language binding project: http://language-binding.net/index.html * C\\C++ Python language binding project: http://language-binding.net/index.html
* Cormoran: http://cormoran.nhopkg.org/docs/ * Cormoran: http://cormoran.nhopkg.org/docs/
* Director: http://packages.python.org/director/ * Director: http://pythonhosted.org/director/
* Dirigible: http://www.projectdirigible.com/documentation/ * Dirigible: http://www.projectdirigible.com/documentation/
* Elemental: http://elemental.googlecode.com/hg/doc/build/html/index.html * Elemental: http://elemental.googlecode.com/hg/doc/build/html/index.html
* F2py: http://f2py.sourceforge.net/docs/ * F2py: http://f2py.sourceforge.net/docs/

10
doc/builders.rst
View File

@ -64,13 +64,13 @@ The builder's "name" must be given to the **-b** command-line option of
Its name is ``qthelp``. Its name is ``qthelp``.
.. _Qt help: http://doc.trolltech.com/4.6/qthelp-framework.html .. _Qt help: http://qt-project.org/doc/qt-4.8/qthelp-framework.html
.. module:: sphinx.builders.devhelp .. module:: sphinx.builders.devhelp
.. class:: DevhelpBuilder .. class:: DevhelpBuilder
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 `GNOME Devhelp <http://live.gnome.org/devhelp>`__ also generates `GNOME Devhelp <https://wiki.gnome.org/Apps/Devhelp>`__
support file that allows the GNOME Devhelp reader to view them. support file that allows the GNOME Devhelp reader to view them.
Its name is ``devhelp``. Its name is ``devhelp``.
@ -110,8 +110,8 @@ The builder's "name" must be given to the **-b** command-line option of
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 <http://rst2pdf.googlecode.com>`_ 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 ``pdf``. Refer to the `rst2pdf manual <http://ralsina.me/static/manual.pdf>`_
<http://lateral.netmanagers.com.ar/static/manual.pdf>`_ for details. for details.
.. module:: sphinx.builders.text .. module:: sphinx.builders.text
.. class:: TextBuilder .. class:: TextBuilder
@ -179,7 +179,7 @@ Note that a direct PDF builder using ReportLab is available in `rst2pdf
globalcontext_filename = 'globalcontext.phpdump' globalcontext_filename = 'globalcontext.phpdump'
searchindex_filename = 'searchindex.phpdump' searchindex_filename = 'searchindex.phpdump'
.. _PHP serialization: http://pypi.python.org/pypi/phpserialize .. _PHP serialization: https://pypi.python.org/pypi/phpserialize
.. attribute:: implementation .. attribute:: implementation

26
doc/develop.rst
View File

@ -6,11 +6,11 @@ Sphinx development
Sphinx is a maintained by a group of volunteers. We value every contribution! Sphinx is a maintained by a group of volunteers. We value every contribution!
* The code can be found in a Mercurial repository, at * The code can be found in a Mercurial repository, at
http://bitbucket.org/birkenfeld/sphinx/. https://bitbucket.org/birkenfeld/sphinx/.
* Issues and feature requests should be raised in the `tracker * Issues and feature requests should be raised in the `tracker
<http://bitbucket.org/birkenfeld/sphinx/issues/>`_. <https://bitbucket.org/birkenfeld/sphinx/issues/>`_.
* The mailing list for development is at `Google Groups * The mailing list for development is at `Google Groups
<http://groups.google.com/group/sphinx-dev/>`_. <https://groups.google.com/group/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/>`_.
@ -82,24 +82,24 @@ own extensions.
.. _gnuplot: http://www.gnuplot.info/ .. _gnuplot: http://www.gnuplot.info/
.. _paver: http://www.blueskyonmars.com/projects/paver/ .. _paver: http://www.blueskyonmars.com/projects/paver/
.. _Sword: http://www.crosswire.org/sword/ .. _Sword: http://www.crosswire.org/sword/
.. _Lilypond: http://lilypond.org/web/ .. _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.sourceforge.net/
.. _PyEnchant: http://www.rfk.id.au/software/pyenchant/ .. _PyEnchant: http://www.rfk.id.au/software/pyenchant/
.. _sadisplay: http://bitbucket.org/estin/sadisplay/wiki/Home .. _sadisplay: https://bitbucket.org/estin/sadisplay/wiki/Home
.. _blockdiag: http://blockdiag.com/ .. _blockdiag: http://blockdiag.com/en/
.. _seqdiag: http://blockdiag.com/ .. _seqdiag: http://blockdiag.com/en/
.. _actdiag: http://blockdiag.com/ .. _actdiag: http://blockdiag.com/en/
.. _nwdiag: http://blockdiag.com/ .. _nwdiag: http://blockdiag.com/en/
.. _Google Chart: http://code.google.com/intl/ja/apis/chart/ .. _Google Chart: https://developers.google.com/chart/
.. _Google Maps: http://maps.google.com/ .. _Google Maps: https://maps.google.com/
.. _hyphenator: http://code.google.com/p/hyphenator/ .. _hyphenator: http://code.google.com/p/hyphenator/
.. _exceltable: http://packages.python.org/sphinxcontrib-exceltable/ .. _exceltable: http://pythonhosted.org/sphinxcontrib-exceltable/
.. _YouTube: http://www.youtube.com/ .. _YouTube: http://www.youtube.com/
.. _ClearQuest: http://www-01.ibm.com/software/awdtools/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: http://sourceforge.net/projects/pgf/

8
doc/devguide.rst
View File

@ -23,7 +23,7 @@ sphinx-dev <sphinx-dev@googlegroups.com>
#sphinx-doc on irc.freenode.net #sphinx-doc on irc.freenode.net
IRC channel for development questions and user support. IRC channel for development questions and user support.
.. _`BitBucket`: http://bitbucket.org .. _`BitBucket`: https://bitbucket.org/
.. _`Mercurial`: http://mercurial.selenic.com/ .. _`Mercurial`: http://mercurial.selenic.com/
@ -43,7 +43,7 @@ Including or providing a link to the source files involved may help us fix the
issue. If possible, try to create a minimal project that produces the error issue. If possible, try to create a minimal project that produces the error
and post that instead. and post that instead.
.. _`issue tracker`: http://bitbucket.org/birkenfeld/sphinx/issues .. _`issue tracker`: https://bitbucket.org/birkenfeld/sphinx/issues
Contributing to Sphinx Contributing to Sphinx
@ -126,7 +126,7 @@ These are the basic steps needed to start developing on Sphinx.
would close issue #42. would close issue #42.
__ https://confluence.atlassian.com/display/BITBUCKET/Automatically+Resolving+Issues+when+Users+Push+Code __ https://confluence.atlassian.com/display/BITBUCKET/Resolve+issues+automatically+when+users+push+code
#. Push changes to your forked repository on BitBucket. :: #. Push changes to your forked repository on BitBucket. ::
@ -190,7 +190,7 @@ identifier and put ``sphinx.po`` in there. Don't forget to update the possible
values for :confval:`language` in ``doc/config.rst``. values for :confval:`language` in ``doc/config.rst``.
The Sphinx core messages can also be translated on `Transifex The Sphinx core messages can also be translated on `Transifex
<http://transifex.com>`_. There exists a client tool named ``tx`` in the Python <https://www.transifex.com/>`_. There exists a client tool named ``tx`` in the Python
package "transifex_client", which can be used to pull translations in ``.po`` package "transifex_client", which can be used to pull translations in ``.po``
format from Transifex. To do this, go to ``sphinx/locale`` and then run format from Transifex. To do this, go to ``sphinx/locale`` and then run
``tx pull -f -l LANG`` where LANG is an existing language identifier. It is ``tx pull -f -l LANG`` where LANG is an existing language identifier. It is

28
doc/domains.rst
View File

@ -828,17 +828,17 @@ Operation_, and Scala_.
.. _sphinx-contrib: https://bitbucket.org/birkenfeld/sphinx-contrib/ .. _sphinx-contrib: https://bitbucket.org/birkenfeld/sphinx-contrib/
.. _Ada: http://pypi.python.org/pypi/sphinxcontrib-adadomain .. _Ada: https://pypi.python.org/pypi/sphinxcontrib-adadomain
.. _CoffeeScript: http://pypi.python.org/pypi/sphinxcontrib-coffee .. _CoffeeScript: https://pypi.python.org/pypi/sphinxcontrib-coffee
.. _Common Lisp: http://pypi.python.org/pypi/sphinxcontrib-cldomain .. _Common Lisp: https://pypi.python.org/pypi/sphinxcontrib-cldomain
.. _dqn: http://pypi.python.org/pypi/sphinxcontrib-dqndomain .. _dqn: https://pypi.python.org/pypi/sphinxcontrib-dqndomain
.. _Erlang: http://pypi.python.org/pypi/sphinxcontrib-erlangdomain .. _Erlang: https://pypi.python.org/pypi/sphinxcontrib-erlangdomain
.. _Go: http://pypi.python.org/pypi/sphinxcontrib-golangdomain .. _Go: https://pypi.python.org/pypi/sphinxcontrib-golangdomain
.. _HTTP: http://pypi.python.org/pypi/sphinxcontrib-httpdomain .. _HTTP: https://pypi.python.org/pypi/sphinxcontrib-httpdomain
.. _Jinja: http://pypi.python.org/pypi/sphinxcontrib-jinjadomain .. _Jinja: https://pypi.python.org/pypi/sphinxcontrib-jinjadomain
.. _Lasso: http://pypi.python.org/pypi/sphinxcontrib-lassodomain .. _Lasso: https://pypi.python.org/pypi/sphinxcontrib-lassodomain
.. _MATLAB: http://pypi.python.org/pypi/sphinxcontrib-matlabdomain .. _MATLAB: https://pypi.python.org/pypi/sphinxcontrib-matlabdomain
.. _Operation: http://pypi.python.org/pypi/sphinxcontrib-operationdomain .. _Operation: https://pypi.python.org/pypi/sphinxcontrib-operationdomain
.. _PHP: http://pypi.python.org/pypi/sphinxcontrib-phpdomain .. _PHP: https://pypi.python.org/pypi/sphinxcontrib-phpdomain
.. _Ruby: http://bitbucket.org/birkenfeld/sphinx-contrib/src/default/rubydomain .. _Ruby: https://bitbucket.org/birkenfeld/sphinx-contrib/src/default/rubydomain
.. _Scala: http://pypi.python.org/pypi/sphinxcontrib-scaladomain .. _Scala: https://pypi.python.org/pypi/sphinxcontrib-scaladomain

6
doc/extensions.rst
View File

@ -68,10 +68,10 @@ maintains a list of those.
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 <http://groups.google.com/group/sphinx-dev>`_). list (`join here <https://groups.google.com/group/sphinx-dev>`_).
.. _Wiki at BitBucket: https://www.bitbucket.org/birkenfeld/sphinx/wiki/Home .. _Wiki at BitBucket: https://bitbucket.org/birkenfeld/sphinx/wiki/Home
.. _Sphinx Contrib: https://www.bitbucket.org/birkenfeld/sphinx-contrib .. _Sphinx Contrib: https://bitbucket.org/birkenfeld/sphinx-contrib
Where to put your own extensions? Where to put your own extensions?

16
doc/faq.rst
View File

@ -37,7 +37,7 @@ How do I...
come through cleanly. come through cleanly.
... create HTML slides from Sphinx documents? ... create HTML slides from Sphinx documents?
See the "Hieroglyph" package at http://github.com/nyergler/hieroglyph. See the "Hieroglyph" package at https://github.com/nyergler/hieroglyph.
For many more extensions and other contributed stuff, see the sphinx-contrib_ For many more extensions and other contributed stuff, see the sphinx-contrib_
repository. repository.
@ -50,7 +50,7 @@ Using Sphinx with...
-------------------- --------------------
Read the Docs Read the Docs
http://readthedocs.org is a documentation hosting service based around Sphinx. https://readthedocs.org is a documentation hosting service based around Sphinx.
They will host sphinx documentation, along with supporting a number of other They will host sphinx documentation, along with supporting a number of other
features including version support, PDF generation, and more. The `Getting features including version support, PDF generation, and more. The `Getting
Started <http://read-the-docs.readthedocs.org/en/latest/getting_started.html>`_ Started <http://read-the-docs.readthedocs.org/en/latest/getting_started.html>`_
@ -62,7 +62,7 @@ Epydoc
Doxygen Doxygen
Michael Jones is developing a reST/Sphinx bridge to doxygen called `breathe Michael Jones is developing a reST/Sphinx bridge to doxygen called `breathe
<http://github.com/michaeljones/breathe/tree/master>`_. <https://github.com/michaeljones/breathe/tree/master>`_.
SCons SCons
Glenn Hutchings has written a SCons build script to build Sphinx Glenn Hutchings has written a SCons build script to build Sphinx
@ -70,9 +70,9 @@ SCons
PyPI PyPI
Jannis Leidel wrote a `setuptools command Jannis Leidel wrote a `setuptools command
<http://pypi.python.org/pypi/Sphinx-PyPI-upload>`_ that automatically uploads <https://pypi.python.org/pypi/Sphinx-PyPI-upload>`_ that automatically uploads
Sphinx documentation to the PyPI package documentation area at Sphinx documentation to the PyPI package documentation area at
http://packages.python.org/. http://pythonhosted.org/.
GitHub Pages GitHub Pages
Directories starting with underscores are ignored by default which breaks Directories starting with underscores are ignored by default which breaks
@ -139,7 +139,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.sourceforge.net/>`_ and create may even use `FontForge <http://fontforge.org/>`_ 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.
@ -168,8 +168,8 @@ The following list gives some hints for the creation of epub files:
.. _Epubcheck: http://code.google.com/p/epubcheck/ .. _Epubcheck: http://code.google.com/p/epubcheck/
.. _Calibre: http://calibre-ebook.com/ .. _Calibre: http://calibre-ebook.com/
.. _FBreader: http://www.fbreader.org/ .. _FBreader: http://fbreader.org/
.. _Bookworm: http://bookworm.oreilly.com/ .. _Bookworm: http://oreilly.com/bookworm/index.html
.. _texinfo-faq: .. _texinfo-faq:

4
doc/install.rst
View File

@ -7,7 +7,7 @@ Since Sphinx is written in the Python language, you need to install Python
(the required version is at least 2.5) and Sphinx. (the required version is at least 2.5) and Sphinx.
Sphinx packages are available on the `Python Package Index Sphinx packages are available on the `Python Package Index
<http://pypi.python.org/pypi/Sphinx>`_. <https://pypi.python.org/pypi/Sphinx>`_.
You can also download a snapshot from the Mercurial development repository: You can also download a snapshot from the Mercurial development repository:
@ -118,7 +118,7 @@ Install the easy_install command
Python has a very useful :command:`easy_install` command which can download and Python has a very useful :command:`easy_install` command which can download and
install 3rd-party libraries with a single command. This is provided by the install 3rd-party libraries with a single command. This is provided by the
"setuptools" project: http://pypi.python.org/pypi/setuptools. "setuptools" project: https://pypi.python.org/pypi/setuptools.
To install setuptools, download To install setuptools, download
https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py and https://bitbucket.org/pypa/setuptools/raw/bootstrap/ez_setup.py and

4
doc/intro.rst
View File

@ -28,7 +28,7 @@ This section is intended to collect helpful hints for those wanting to migrate
to reStructuredText/Sphinx from other documentation systems. to reStructuredText/Sphinx from other documentation systems.
* Gerard Flanagan has written a script to convert pure HTML to reST; it can be * Gerard Flanagan has written a script to convert pure HTML to reST; it can be
found at the `Python Package Index <http://pypi.python.org/pypi/html2rest>`_. found at the `Python Package Index <https://pypi.python.org/pypi/html2rest>`_.
* For converting the old Python docs to Sphinx, a converter was written which * For converting the old Python docs to Sphinx, a converter was written which
can be found at `the Python SVN repository can be found at `the Python SVN repository
@ -39,7 +39,7 @@ to reStructuredText/Sphinx from other documentation systems.
markup; it is at `Google Code <http://code.google.com/p/db2rst/>`_. markup; it is at `Google Code <http://code.google.com/p/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 <http://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://johnmacfarlane.net/pandoc/>`_ is
a very helpful tool. a very helpful tool.

2
doc/invocation.rst
View File

@ -270,7 +270,7 @@ The :program:`sphinx-apidoc` script has several options:
filesystem to discover packages and modules. You may need it if you want filesystem to discover packages and modules. You may need it if you want
to generate documentation from a source directory managed by to generate documentation from a source directory managed by
`collective.recipe.omelette `collective.recipe.omelette
<http://pypi.python.org/pypi/collective.recipe.omelette/>`_. <https://pypi.python.org/pypi/collective.recipe.omelette/>`_.
By default, symbolic links are skipped. By default, symbolic links are skipped.
.. versionadded:: 1.2 .. versionadded:: 1.2