mirror of
https://github.com/sphinx-doc/sphinx.git
synced 2025-02-25 18:55:22 -06:00
Closes #1735: Use https://doc.python.org/ instead of `http protocol. It was used for sphinx.ext.intersphinx` and some documentation.
This commit is contained in:
2
doc/_templates/index.html
vendored
2
doc/_templates/index.html
vendored
@@ -12,7 +12,7 @@
|
||||
<p>{%trans%}
|
||||
Sphinx is a tool that makes it easy to create intelligent and beautiful
|
||||
documentation, written by Georg Brandl and licensed under the BSD license.{%endtrans%}</p>
|
||||
<p>{%trans%}It was originally created for <a href="http://docs.python.org/">the
|
||||
<p>{%trans%}It was originally created for <a href="https://docs.python.org/">the
|
||||
new Python documentation</a>, and it has excellent facilities for the
|
||||
documentation of Python projects, but C/C++ is already supported as well,
|
||||
and it is planned to add special support for other languages as well. Of
|
||||
|
||||
@@ -84,7 +84,7 @@ texinfo_documents = [
|
||||
|
||||
# We're not using intersphinx right now, but if we did, this would be part of
|
||||
# the mapping:
|
||||
intersphinx_mapping = {'python': ('http://docs.python.org/2/', None)}
|
||||
intersphinx_mapping = {'python': ('https://docs.python.org/2/', None)}
|
||||
|
||||
# Sphinx document translation with sphinx gettext feature uses these settings:
|
||||
locale_dirs = ['locale/']
|
||||
|
||||
@@ -768,7 +768,7 @@ that use Sphinx's HTMLWriter class.
|
||||
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
|
||||
served (without trailing slash), e.g. ``"http://docs.python.org"``. The
|
||||
served (without trailing slash), e.g. ``"https://docs.python.org"``. The
|
||||
default is ``''``.
|
||||
|
||||
.. confval:: html_file_suffix
|
||||
|
||||
@@ -84,7 +84,7 @@ linking:
|
||||
To add links to modules and objects in the Python standard library
|
||||
documentation, use::
|
||||
|
||||
intersphinx_mapping = {'python': ('http://docs.python.org/3.4', None)}
|
||||
intersphinx_mapping = {'python': ('https://docs.python.org/3.4', None)}
|
||||
|
||||
This will download the corresponding :file:`objects.inv` file from the
|
||||
Internet and generate links to the pages under the given URI. The downloaded
|
||||
@@ -94,12 +94,12 @@ linking:
|
||||
A second example, showing the meaning of a non-``None`` value of the second
|
||||
tuple item::
|
||||
|
||||
intersphinx_mapping = {'python': ('http://docs.python.org/3.4',
|
||||
intersphinx_mapping = {'python': ('https://docs.python.org/3.4',
|
||||
'python-inv.txt')}
|
||||
|
||||
This will read the inventory from :file:`python-inv.txt` in the source
|
||||
directory, but still generate links to the pages under
|
||||
``http://docs.python.org/3.4``. It is up to you to update the inventory file
|
||||
``https://docs.python.org/3.4``. It is up to you to update the inventory file
|
||||
as new objects are added to the Python documentation.
|
||||
|
||||
**Multiple target for the inventory**
|
||||
@@ -113,7 +113,7 @@ linking:
|
||||
this to specify mirror sites for server downtime of the primary
|
||||
inventory::
|
||||
|
||||
intersphinx_mapping = {'python': ('http://docs.python.org/3.4',
|
||||
intersphinx_mapping = {'python': ('https://docs.python.org/3.4',
|
||||
(None, 'python-inv.txt'))}
|
||||
|
||||
.. confval:: intersphinx_cache_limit
|
||||
|
||||
@@ -133,7 +133,7 @@ These themes are:
|
||||
include ``px`` in the value.) Defaults to 230 pixels.
|
||||
|
||||
* **default** -- This is the default theme, which looks like `the Python
|
||||
documentation <http://docs.python.org/>`_. It can be customized via these
|
||||
documentation <https://docs.python.org/>`_. It can be customized via these
|
||||
options:
|
||||
|
||||
- **rightsidebar** (true or false): Put the sidebar on the right side.
|
||||
|
||||
@@ -273,7 +273,7 @@ Many Sphinx documents including the `Python documentation`_ are published on the
|
||||
internet. When you want to make links to such documents from your
|
||||
documentation, you can do it with :mod:`sphinx.ext.intersphinx`.
|
||||
|
||||
.. _Python documentation: http://docs.python.org/3
|
||||
.. _Python documentation: https://docs.python.org/3
|
||||
|
||||
In order to use intersphinx, you need to activate it in :file:`conf.py` by
|
||||
putting the string ``'sphinx.ext.intersphinx'`` into the :confval:`extensions`
|
||||
@@ -282,7 +282,7 @@ list and set up the :confval:`intersphinx_mapping` config value.
|
||||
For example, to link to ``io.open()`` in the Python library manual, you need to
|
||||
setup your :confval:`intersphinx_mapping` like::
|
||||
|
||||
intersphinx_mapping = {'python': ('http://docs.python.org/3', None)}
|
||||
intersphinx_mapping = {'python': ('https://docs.python.org/3', None)}
|
||||
|
||||
And now, you can write a cross-reference like ``:py:func:`io.open```. Any
|
||||
cross-reference that has no matching target in the current documentation set,
|
||||
|
||||
Reference in New Issue
Block a user