mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
doc: Upgrade docutils.sourceforge.io links to HTTPS
Also change any docutils.sourceforge.net link to io top level domain.
This commit is contained in:
4
doc/_templates/index.html
vendored
4
doc/_templates/index.html
vendored
@@ -38,10 +38,10 @@
|
|||||||
most of them installable from PyPI{%endtrans%}</li>
|
most of them installable from PyPI{%endtrans%}</li>
|
||||||
</ul>
|
</ul>
|
||||||
<p>{%trans%}
|
<p>{%trans%}
|
||||||
Sphinx uses <a href="http://docutils.sourceforge.net/rst.html">reStructuredText</a>
|
Sphinx uses <a href="https://docutils.sourceforge.io/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.sourceforge.net/">Docutils</a>.{%endtrans%}
|
suite, the <a href="https://docutils.sourceforge.io/">Docutils</a>.{%endtrans%}
|
||||||
</p>
|
</p>
|
||||||
|
|
||||||
<h2 style="margin-bottom: 0">{%trans%}Documentation{%endtrans%}</h2>
|
<h2 style="margin-bottom: 0">{%trans%}Documentation{%endtrans%}</h2>
|
||||||
|
|||||||
@@ -80,11 +80,11 @@ latex_use_xindy = True
|
|||||||
autodoc_member_order = 'groupwise'
|
autodoc_member_order = 'groupwise'
|
||||||
autosummary_generate = False
|
autosummary_generate = False
|
||||||
todo_include_todos = True
|
todo_include_todos = True
|
||||||
extlinks = {'duref': ('http://docutils.sourceforge.net/docs/ref/rst/'
|
extlinks = {'duref': ('https://docutils.sourceforge.io/docs/ref/rst/'
|
||||||
'restructuredtext.html#%s', ''),
|
'restructuredtext.html#%s', ''),
|
||||||
'durole': ('http://docutils.sourceforge.net/docs/ref/rst/'
|
'durole': ('https://docutils.sourceforge.io/docs/ref/rst/'
|
||||||
'roles.html#%s', ''),
|
'roles.html#%s', ''),
|
||||||
'dudir': ('http://docutils.sourceforge.net/docs/ref/rst/'
|
'dudir': ('https://docutils.sourceforge.io/docs/ref/rst/'
|
||||||
'directives.html#%s', '')}
|
'directives.html#%s', '')}
|
||||||
|
|
||||||
man_pages = [
|
man_pages = [
|
||||||
|
|||||||
@@ -181,9 +181,9 @@ This is the very basic principle of an extension that creates a new directive.
|
|||||||
For a more advanced example, refer to :doc:`todo`.
|
For a more advanced example, refer to :doc:`todo`.
|
||||||
|
|
||||||
|
|
||||||
.. _docutils: http://docutils.sourceforge.net/
|
.. _docutils: https://docutils.sourceforge.io/
|
||||||
.. _docutils directives: http://docutils.sourceforge.net/docs/howto/rst-directives.html
|
.. _docutils directives: https://docutils.sourceforge.io/docs/howto/rst-directives.html
|
||||||
.. _docutils nodes: http://docutils.sourceforge.net/docs/ref/doctree.html
|
.. _docutils nodes: https://docutils.sourceforge.io/docs/ref/doctree.html
|
||||||
.. _PyPI: https://pypi.org/
|
.. _PyPI: https://pypi.org/
|
||||||
.. _Python package: https://packaging.python.org/
|
.. _Python package: https://packaging.python.org/
|
||||||
.. _Python path: https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH
|
.. _Python path: https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH
|
||||||
|
|||||||
@@ -223,4 +223,4 @@ Further reading
|
|||||||
For more information, refer to the `docutils`_ documentation and
|
For more information, refer to the `docutils`_ documentation and
|
||||||
:doc:`/extdev/index`.
|
:doc:`/extdev/index`.
|
||||||
|
|
||||||
.. _docutils: http://docutils.sourceforge.net/docs/
|
.. _docutils: https://docutils.sourceforge.io/docs/
|
||||||
|
|||||||
@@ -105,7 +105,7 @@ is just a "general" node.
|
|||||||
|
|
||||||
Many extensions will not have to create their own node classes and work fine
|
Many extensions will not have to create their own node classes and work fine
|
||||||
with the nodes already provided by `docutils
|
with the nodes already provided by `docutils
|
||||||
<http://docutils.sourceforge.net/docs/ref/doctree.html>`__ and :ref:`Sphinx
|
<https://docutils.sourceforge.io/docs/ref/doctree.html>`__ and :ref:`Sphinx
|
||||||
<nodes>`.
|
<nodes>`.
|
||||||
|
|
||||||
.. attention::
|
.. attention::
|
||||||
@@ -362,6 +362,6 @@ For more information, refer to the `docutils`_ documentation and
|
|||||||
:doc:`/extdev/index`.
|
:doc:`/extdev/index`.
|
||||||
|
|
||||||
|
|
||||||
.. _docutils: http://docutils.sourceforge.net/docs/
|
.. _docutils: https://docutils.sourceforge.io/docs/
|
||||||
.. _Python path: https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH
|
.. _Python path: https://docs.python.org/3/using/cmdline.html#envvar-PYTHONPATH
|
||||||
.. _docutils documentation: http://docutils.sourceforge.net/docs/ref/rst/directives.html
|
.. _docutils documentation: https://docutils.sourceforge.io/docs/ref/rst/directives.html
|
||||||
|
|||||||
@@ -112,7 +112,7 @@ in which a Sphinx project is built: this works in several phases.
|
|||||||
existing files are read, temporary nodes are created.
|
existing files are read, temporary nodes are created.
|
||||||
|
|
||||||
There are nodes provided by docutils, which are documented `in the docutils
|
There are nodes provided by docutils, which are documented `in the docutils
|
||||||
documentation <http://docutils.sourceforge.net/docs/ref/doctree.html>`__.
|
documentation <https://docutils.sourceforge.io/docs/ref/doctree.html>`__.
|
||||||
Additional nodes are provided by Sphinx and :ref:`documented here <nodes>`.
|
Additional nodes are provided by Sphinx and :ref:`documented here <nodes>`.
|
||||||
|
|
||||||
During reading, the build environment is updated with all meta- and cross
|
During reading, the build environment is updated with all meta- and cross
|
||||||
|
|||||||
@@ -149,4 +149,4 @@ return ``node.children`` from the Directive.
|
|||||||
|
|
||||||
`Creating directives`_ HOWTO of the Docutils documentation
|
`Creating directives`_ HOWTO of the Docutils documentation
|
||||||
|
|
||||||
.. _Creating directives: http://docutils.sourceforge.net/docs/howto/rst-directives.html
|
.. _Creating directives: https://docutils.sourceforge.io/docs/howto/rst-directives.html
|
||||||
|
|||||||
@@ -8,7 +8,7 @@ Parser API
|
|||||||
The Parser analyzes the input document and creates a node tree
|
The Parser analyzes the input document and creates a node tree
|
||||||
representation.
|
representation.
|
||||||
|
|
||||||
__ http://docutils.sourceforge.net/docs/dev/hacking.html#parsing-the-document
|
__ https://docutils.sourceforge.io/docs/dev/hacking.html#parsing-the-document
|
||||||
|
|
||||||
In Sphinx, the parser modules works as same as docutils. The parsers are
|
In Sphinx, the parser modules works as same as docutils. The parsers are
|
||||||
registered to Sphinx by extensions using Application APIs;
|
registered to Sphinx by extensions using Application APIs;
|
||||||
|
|||||||
10
doc/faq.rst
10
doc/faq.rst
@@ -145,7 +145,7 @@ Google Search
|
|||||||
|
|
||||||
.. _Getting Started: https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
|
.. _Getting Started: https://docs.readthedocs.io/en/stable/intro/getting-started-with-sphinx.html
|
||||||
.. _api role: https://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py
|
.. _api role: https://git.savannah.gnu.org/cgit/kenozooid.git/tree/doc/extapi.py
|
||||||
.. _xhtml to reST: http://docutils.sourceforge.net/sandbox/xhtml2rest/xhtml2rest.py
|
.. _xhtml to reST: https://docutils.sourceforge.io/sandbox/xhtml2rest/xhtml2rest.py
|
||||||
|
|
||||||
|
|
||||||
Sphinx vs. Docutils
|
Sphinx vs. Docutils
|
||||||
@@ -179,10 +179,10 @@ of the *writers* provided by docutils. This allows Sphinx to provide many
|
|||||||
features that would simply not be possible with docutils, such as those
|
features that would simply not be possible with docutils, such as those
|
||||||
outlined above.
|
outlined above.
|
||||||
|
|
||||||
__ http://docutils.sourceforge.io/
|
__ https://docutils.sourceforge.io/
|
||||||
__ http://docutils.sourceforge.io/docs/dev/hacking.html
|
__ https://docutils.sourceforge.io/docs/dev/hacking.html
|
||||||
__ http://docutils.sourceforge.io/rst.html
|
__ https://docutils.sourceforge.io/rst.html
|
||||||
__ http://docutils.sourceforge.net/docs/user/tools.html
|
__ https://docutils.sourceforge.io/docs/user/tools.html
|
||||||
|
|
||||||
|
|
||||||
.. _epub-faq:
|
.. _epub-faq:
|
||||||
|
|||||||
@@ -297,7 +297,7 @@ Debugging tips
|
|||||||
will complain about references without a known target.
|
will complain about references without a known target.
|
||||||
|
|
||||||
* Set the debugging options in the `Docutils configuration file
|
* Set the debugging options in the `Docutils configuration file
|
||||||
<http://docutils.sourceforge.net/docs/user/config.html>`_.
|
<https://docutils.sourceforge.io/docs/user/config.html>`_.
|
||||||
|
|
||||||
* JavaScript stemming algorithms in ``sphinx/search/*.py`` (except ``en.py``)
|
* JavaScript stemming algorithms in ``sphinx/search/*.py`` (except ``en.py``)
|
||||||
are generated by this `modified snowballcode generator
|
are generated by this `modified snowballcode generator
|
||||||
|
|||||||
@@ -18,8 +18,8 @@ and output behavior.
|
|||||||
directory to adjust `Docutils`_ configuration if not otherwise overridden or
|
directory to adjust `Docutils`_ configuration if not otherwise overridden or
|
||||||
set by Sphinx.
|
set by Sphinx.
|
||||||
|
|
||||||
.. _`docutils`: http://docutils.sourceforge.net/
|
.. _`docutils`: https://docutils.sourceforge.io/
|
||||||
.. _`docutils.conf`: http://docutils.sourceforge.net/docs/user/config.html
|
.. _`docutils.conf`: https://docutils.sourceforge.io/docs/user/config.html
|
||||||
|
|
||||||
The configuration file is executed as Python code at build time (using
|
The configuration file is executed as Python code at build time (using
|
||||||
:func:`execfile`, and with the current directory set to its containing
|
:func:`execfile`, and with the current directory set to its containing
|
||||||
@@ -484,7 +484,7 @@ General configuration
|
|||||||
languages, will be used to convert quotes and dashes to typographically
|
languages, will be used to convert quotes and dashes to typographically
|
||||||
correct entities. Default: ``True``.
|
correct entities. Default: ``True``.
|
||||||
|
|
||||||
__ http://docutils.sourceforge.net/docs/user/smartquotes.html
|
__ https://docutils.sourceforge.io/docs/user/smartquotes.html
|
||||||
__ https://daringfireball.net/projects/smartypants/
|
__ https://daringfireball.net/projects/smartypants/
|
||||||
|
|
||||||
.. versionadded:: 1.6.6
|
.. versionadded:: 1.6.6
|
||||||
@@ -497,8 +497,8 @@ General configuration
|
|||||||
*deactivates* smart quotes via the corresponding `Docutils option`__. But
|
*deactivates* smart quotes via the corresponding `Docutils option`__. But
|
||||||
if it *activates* them, then :confval:`smartquotes` does prevail.
|
if it *activates* them, then :confval:`smartquotes` does prevail.
|
||||||
|
|
||||||
__ http://docutils.sourceforge.net/docs/user/config.html
|
__ https://docutils.sourceforge.io/docs/user/config.html
|
||||||
__ http://docutils.sourceforge.net/docs/user/config.html#smart-quotes
|
__ https://docutils.sourceforge.io/docs/user/config.html#smart-quotes
|
||||||
|
|
||||||
.. confval:: smartquotes_action
|
.. confval:: smartquotes_action
|
||||||
|
|
||||||
|
|||||||
@@ -49,7 +49,7 @@ parse them. This happens in an intermediate step while Sphinx is processing
|
|||||||
the documentation, so it doesn't modify any of the docstrings in your actual
|
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: https://docutils.sourceforge.io/rst.html
|
||||||
.. _docstrings: https://www.python.org/dev/peps/pep-0287/
|
.. _docstrings: https://www.python.org/dev/peps/pep-0287/
|
||||||
.. _Google Python Style Guide:
|
.. _Google Python Style Guide:
|
||||||
https://google.github.io/styleguide/pyguide.html
|
https://google.github.io/styleguide/pyguide.html
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ language, this will not take too long.
|
|||||||
.. seealso::
|
.. seealso::
|
||||||
|
|
||||||
The authoritative `reStructuredText User Documentation
|
The authoritative `reStructuredText User Documentation
|
||||||
<http://docutils.sourceforge.net/rst.html>`_. The "ref" links in this
|
<https://docutils.sourceforge.io/rst.html>`_. The "ref" links in this
|
||||||
document link to the description of the individual constructs in the reST
|
document link to the description of the individual constructs in the reST
|
||||||
reference.
|
reference.
|
||||||
|
|
||||||
|
|||||||
@@ -12,7 +12,7 @@ The below guides go through the most important aspects of reST. For the
|
|||||||
authoritative reStructuredText reference, refer to the `docutils
|
authoritative reStructuredText reference, refer to the `docutils
|
||||||
documentation`__.
|
documentation`__.
|
||||||
|
|
||||||
__ http://docutils.sourceforge.net/rst.html
|
__ https://docutils.sourceforge.io/rst.html
|
||||||
|
|
||||||
.. toctree::
|
.. toctree::
|
||||||
:maxdepth: 2
|
:maxdepth: 2
|
||||||
|
|||||||
@@ -666,7 +666,7 @@ class Sphinx:
|
|||||||
add_directive('my-directive', MyDirective)
|
add_directive('my-directive', MyDirective)
|
||||||
|
|
||||||
For more details, see `the Docutils docs
|
For more details, see `the Docutils docs
|
||||||
<http://docutils.sourceforge.net/docs/howto/rst-directives.html>`__ .
|
<https://docutils.sourceforge.io/docs/howto/rst-directives.html>`__ .
|
||||||
|
|
||||||
.. versionchanged:: 0.6
|
.. versionchanged:: 0.6
|
||||||
Docutils 0.5-style directive classes are now supported.
|
Docutils 0.5-style directive classes are now supported.
|
||||||
@@ -691,7 +691,7 @@ class Sphinx:
|
|||||||
installed as the same name
|
installed as the same name
|
||||||
|
|
||||||
For more details about role functions, see `the Docutils docs
|
For more details about role functions, see `the Docutils docs
|
||||||
<http://docutils.sourceforge.net/docs/howto/rst-roles.html>`__ .
|
<https://docutils.sourceforge.io/docs/howto/rst-roles.html>`__ .
|
||||||
|
|
||||||
.. versionchanged:: 1.8
|
.. versionchanged:: 1.8
|
||||||
Add *override* keyword.
|
Add *override* keyword.
|
||||||
@@ -929,7 +929,7 @@ class Sphinx:
|
|||||||
|
|
||||||
refs: `Transform Priority Range Categories`__
|
refs: `Transform Priority Range Categories`__
|
||||||
|
|
||||||
__ http://docutils.sourceforge.net/docs/ref/transforms.html#transform-priority-range-categories
|
__ https://docutils.sourceforge.io/docs/ref/transforms.html#transform-priority-range-categories
|
||||||
""" # NOQA
|
""" # NOQA
|
||||||
self.registry.add_transform(transform)
|
self.registry.add_transform(transform)
|
||||||
|
|
||||||
|
|||||||
@@ -47,7 +47,7 @@ class MetadataCollector(EnvironmentCollector):
|
|||||||
md[field_name.astext()] = field_body.astext()
|
md[field_name.astext()] = field_body.astext()
|
||||||
elif isinstance(node, nodes.TextElement):
|
elif isinstance(node, nodes.TextElement):
|
||||||
# other children must be TextElement
|
# other children must be TextElement
|
||||||
# see: http://docutils.sourceforge.net/docs/ref/doctree.html#bibliographic-elements # NOQA
|
# see: https://docutils.sourceforge.io/docs/ref/doctree.html#bibliographic-elements # NOQA
|
||||||
md[node.__class__.__name__] = node.astext()
|
md[node.__class__.__name__] = node.astext()
|
||||||
|
|
||||||
for name, value in md.items():
|
for name, value in md.items():
|
||||||
|
|||||||
@@ -261,7 +261,7 @@ class Locale(SphinxTransform):
|
|||||||
|
|
||||||
# Structural Subelements phase1
|
# Structural Subelements phase1
|
||||||
# There is a possibility that only the title node is created.
|
# There is a possibility that only the title node is created.
|
||||||
# see: http://docutils.sourceforge.net/docs/ref/doctree.html#structural-subelements
|
# see: https://docutils.sourceforge.io/docs/ref/doctree.html#structural-subelements
|
||||||
if isinstance(node, nodes.title):
|
if isinstance(node, nodes.title):
|
||||||
# This generates: <section ...><title>msgstr</title></section>
|
# This generates: <section ...><title>msgstr</title></section>
|
||||||
msgstr = msgstr + '\n' + '=' * len(msgstr) * 2
|
msgstr = msgstr + '\n' + '=' * len(msgstr) * 2
|
||||||
|
|||||||
@@ -5,7 +5,7 @@ Translation Tips
|
|||||||
-----------------
|
-----------------
|
||||||
|
|
||||||
.. _download Sphinx: https://pypi.org/project/Sphinx/
|
.. _download Sphinx: https://pypi.org/project/Sphinx/
|
||||||
.. _Docutils site: http://docutils.sourceforge.net/
|
.. _Docutils site: https://docutils.sourceforge.io/
|
||||||
.. _Sphinx site: http://sphinx-doc.org/
|
.. _Sphinx site: http://sphinx-doc.org/
|
||||||
|
|
||||||
|
|
||||||
|
|||||||
@@ -410,7 +410,7 @@ def test_text_admonitions(app):
|
|||||||
app.build()
|
app.build()
|
||||||
# --- admonitions
|
# --- admonitions
|
||||||
# #1206: gettext did not translate admonition directive's title
|
# #1206: gettext did not translate admonition directive's title
|
||||||
# seealso: http://docutils.sourceforge.net/docs/ref/rst/directives.html#admonitions
|
# seealso: https://docutils.sourceforge.io/docs/ref/rst/directives.html#admonitions
|
||||||
result = (app.outdir / 'admonitions.txt').read_text()
|
result = (app.outdir / 'admonitions.txt').read_text()
|
||||||
directives = (
|
directives = (
|
||||||
"attention", "caution", "danger", "error", "hint",
|
"attention", "caution", "danger", "error", "hint",
|
||||||
|
|||||||
@@ -9,7 +9,7 @@
|
|||||||
"""
|
"""
|
||||||
|
|
||||||
# adapted from an example of bibliographic metadata at
|
# adapted from an example of bibliographic metadata at
|
||||||
# http://docutils.sourceforge.net/docs/user/rst/demo.txt
|
# https://docutils.sourceforge.io/docs/user/rst/demo.txt
|
||||||
|
|
||||||
import pytest
|
import pytest
|
||||||
|
|
||||||
|
|||||||
@@ -15,7 +15,7 @@ from sphinx.writers.latex import rstdim_to_latexdim
|
|||||||
|
|
||||||
def test_rstdim_to_latexdim():
|
def test_rstdim_to_latexdim():
|
||||||
# Length units docutils supported
|
# Length units docutils supported
|
||||||
# http://docutils.sourceforge.net/docs/ref/rst/restructuredtext.html#length-units
|
# https://docutils.sourceforge.io/docs/ref/rst/restructuredtext.html#length-units
|
||||||
assert rstdim_to_latexdim('160em') == '160em'
|
assert rstdim_to_latexdim('160em') == '160em'
|
||||||
assert rstdim_to_latexdim('160px') == '160\\sphinxpxdimen'
|
assert rstdim_to_latexdim('160px') == '160\\sphinxpxdimen'
|
||||||
assert rstdim_to_latexdim('160in') == '160in'
|
assert rstdim_to_latexdim('160in') == '160in'
|
||||||
|
|||||||
Reference in New Issue
Block a user