Merge pull request #56671 from bryceml/update_sphinx

update sphinx to 3.0.1

doc/conf.py

@@ -9,7 +9,7 @@ import sys
 import time
 import types
 
-from sphinx.directives import TocTree
+from sphinx.directives.other import TocTree
 
 
 class Mock(object):
@@ -86,7 +86,6 @@ MOCK_MODULES = [
     # Python stdlib
     "user",
     # salt core
-    "concurrent",
     "Crypto",
     "Crypto.Signature",
     "Crypto.Cipher",
@@ -150,7 +149,6 @@ MOCK_MODULES = [
     "OpenSSL",
     "avahi",
     "boto.regioninfo",
-    "concurrent",
     "dbus",
     "django",
     "dns",

doc/glossary.rst

@@ -104,7 +104,7 @@ Glossary
         or stored externally.
 
     Job ID
-        A unique identifier to represent a given :term:`job`.  This is often
+        A unique identifier to represent a given :term:`job <Job>`.  This is often
         shortened to JID.
 
     Low State
@@ -227,7 +227,7 @@ Glossary
         Contains a set of :term:`state declarations <State Declaration>`.
 
     State Compiler
-        Translates :term:`highdata` into lowdata.
+        Translates :term:`highdata <Highdata>` into lowdata.
 
     State Declaration
         A data structure which contains a unique ID and describes one or more

doc/ref/configuration/index.rst

@@ -5,8 +5,8 @@ Configuring Salt
 ================
 
 Salt configuration is very simple. The default configuration for the
-:term:`master` will work for most installations and the only requirement for
-setting up a :term:`minion` is to set the location of the master in the minion
+:term:`master <Master>` will work for most installations and the only requirement for
+setting up a :term:`minion <Minion>` is to set the location of the master in the minion
 configuration file.
 
 The configuration files will be installed to :file:`/etc/salt` and are named

doc/ref/configuration/master.rst

@@ -4033,7 +4033,7 @@ ext_pillar keys to override those from :conf_master:`pillar_roots`.
 
     ext_pillar_first: False
 
-.. conf_minion:: pillarenv_from_saltenv
+.. conf_master:: pillarenv_from_saltenv
 
 ``pillarenv_from_saltenv``
 --------------------------

doc/ref/configuration/minion.rst

@@ -710,7 +710,7 @@ This directory may contain sensitive data and should be protected accordingly.
 
     cachedir: /var/cache/salt/minion
 
-.. conf_master:: color_theme
+.. conf_minion:: color_theme
 
 ``color_theme``
 ---------------

doc/topics/beacons/index.rst

@@ -241,7 +241,7 @@ Add the following to ``/srv/reactor/revert.sls``:
     In addition to :ref:`setting <avoid-beacon-event-loops>`
     ``disable_during_state_run: True`` for an inotify beacon whose reaction is
     to modify the watched file, it is important to ensure the state applied is
-    also :term:`idempotent`.
+    also :term:`idempotent <Idempotent>`.
 
 .. note::
 

doc/topics/cloud/openstack.rst

@@ -2,4 +2,4 @@
 Getting Started with Openstack
 ==============================
 
-.. automodule:: salt.cloud.clouds.openstack
+See :mod:`salt.cloud.clouds.openstack`

doc/topics/grains/index.rst

@@ -102,7 +102,7 @@ same way as in the above example, only without a top-level ``grains:`` key:
 Matching Grains in the Top File
 ===============================
 
-With correctly configured grains on the Minion, the :term:`top file` used in
+With correctly configured grains on the Minion, the :term:`top file <Top File>` used in
 Pillar or during Highstate can be made very efficient. For example, consider
 the following configuration:
 

doc/topics/targeting/compound.rst

@@ -6,7 +6,7 @@ Compound matchers
 
 Compound matchers allow very granular minion targeting using any of Salt's
 matchers. The default matcher is a :mod:`glob <python2:fnmatch>` match, just as
-with CLI and :term:`top file` matching. To match using anything other than a
+with CLI and :term:`top file <Top File>` matching. To match using anything other than a
 glob, prefix the match string with the appropriate letter from the table below,
 followed by an ``@`` sign.
 
@@ -34,7 +34,7 @@ matches the :mod:`regular expression <python2:re>` ``web-dc1-srv.*``:
 
     salt -C 'webserv* and G@os:Debian or E@web-dc1-srv.*' test.version
 
-That same example expressed in a :term:`top file` looks like the following:
+That same example expressed in a :term:`top file <Top File>` looks like the following:
 
 .. code-block:: yaml
 

doc/topics/targeting/globbing.rst

@@ -11,7 +11,7 @@ configuration setting.
 
 .. tip:: minion id and minion keys
 
-    The :term:`minion id` is used to generate the minion's public/private keys
+    The :term:`minion id <Minion ID>` is used to generate the minion's public/private keys
     and if it ever changes the master must then accept the new key as though
     the minion was a new host.
 
@@ -19,8 +19,8 @@ Globbing
 ========
 
 The default matching that Salt utilizes is :py:mod:`shell-style globbing
-<python2:fnmatch>` around the :term:`minion id`. This also works for states
-in the :term:`top file`.
+<python2:fnmatch>` around the :term:`minion id <Minion ID>`. This also works for states
+in the :term:`top file <Top File>`.
 
 .. note::
 
@@ -83,7 +83,7 @@ Match both ``web1-prod`` and ``web1-devel`` minions:
 
     salt -E 'web1-(prod|devel)' test.version
 
-When using regular expressions in a State's :term:`top file`, you must specify
+When using regular expressions in a State's :term:`top file <Top File>`, you must specify
 the matcher as the first option. The following example executes the contents of
 ``webserver.sls`` on the above-mentioned minions.
 

doc/topics/targeting/index.rst

@@ -12,7 +12,7 @@ For example the command ``salt web1 apache.signal restart`` to restart the
 Apache httpd server specifies the machine ``web1`` as the target and the
 command will only be run on that one minion.
 
-Similarly when using States, the following :term:`top file` specifies that only
+Similarly when using States, the following :term:`top file <Top File>` specifies that only
 the ``web1`` minion should execute the contents of ``webserver.sls``:
 
 .. code-block:: yaml

doc/topics/targeting/nodegroups.rst

@@ -63,11 +63,11 @@ To match a nodegroup on the CLI, use the ``-N`` command-line option:
 .. note::
 
     The ``N@`` classifier historically could not be used in compound matches
-    within the CLI or :term:`top file`, it was only recognized in the
+    within the CLI or :term:`top file <Top File>`, it was only recognized in the
     :conf_master:`nodegroups` master config file parameter. As of the 2019.2.0
     release, this limitation no longer exists.
 
-To match a nodegroup in your :term:`top file`, make sure to put ``- match:
+To match a nodegroup in your :term:`top file <Top File>`, make sure to put ``- match:
 nodegroup`` on the line directly following the nodegroup name.
 
 .. code-block:: yaml

doc/topics/tutorials/http.rst

@@ -188,7 +188,7 @@ password may be passed in as ``username`` and ``password``, respectively.
     salt.utils.http.query(
         'http://example.com',
         username='larry',
-        password=`5700g3543v4r`,
+        password='5700g3543v4r',
     )
 
 Cookies and Sessions

doc/topics/tutorials/modules.rst

@@ -9,7 +9,7 @@ Remote execution tutorial
 Order your minions around
 =========================
 
-Now that you have a :term:`master` and at least one :term:`minion`
+Now that you have a :term:`master <Master>` and at least one :term:`minion <Minion>`
 communicating with each other you can perform commands on the minion via the
 :command:`salt` command. Salt calls are comprised of three main components:
 

doc/topics/tutorials/pillar.rst

@@ -141,7 +141,7 @@ This example sets up user data with a UID:
 
     The same directory lookups that exist in states exist in pillar, so the
     file ``users/init.sls`` can be referenced with ``users`` in the :term:`top
-    file`.
+    file <Top File>`.
 
 The top file will need to be updated to include this sls file:
 

requirements/static/docs.in

@@ -1 +1 @@
-sphinx>=2.0.1
+sphinx>=3.0.1

requirements/static/py3.5/docs.txt

@@ -5,26 +5,26 @@
 #    pip-compile -o requirements/static/py3.5/docs.txt -v requirements/static/docs.in
 #
 alabaster==0.7.12         # via sphinx
-babel==2.7.0              # via sphinx
-certifi==2019.3.9         # via requests
+babel==2.8.0              # via sphinx
+certifi==2020.4.5.1       # via requests
 chardet==3.0.4            # via requests
-docutils==0.14            # via sphinx
-idna==2.8                 # via requests
-imagesize==1.1.0          # via sphinx
-jinja2==2.10.1            # via sphinx
+docutils==0.16            # via sphinx
+idna==2.9                 # via requests
+imagesize==1.2.0          # via sphinx
+jinja2==2.11.2            # via sphinx
 markupsafe==1.1.1         # via jinja2
-packaging==19.0           # via sphinx
-pygments==2.4.2           # via sphinx
-pyparsing==2.4.0          # via packaging
-pytz==2019.1              # via babel
-requests==2.22.0          # via sphinx
-six==1.12.0               # via packaging
-snowballstemmer==1.2.1    # via sphinx
-sphinx==2.0.1
-sphinxcontrib-applehelp==1.0.1  # via sphinx
-sphinxcontrib-devhelp==1.0.1  # via sphinx
-sphinxcontrib-htmlhelp==1.0.2  # via sphinx
+packaging==20.3           # via sphinx
+pygments==2.6.1           # via sphinx
+pyparsing==2.4.7          # via packaging
+pytz==2019.3              # via babel
+requests==2.23.0          # via sphinx
+six==1.14.0               # via packaging
+snowballstemmer==2.0.0    # via sphinx
+sphinx==3.0.1
+sphinxcontrib-applehelp==1.0.2  # via sphinx
+sphinxcontrib-devhelp==1.0.2  # via sphinx
+sphinxcontrib-htmlhelp==1.0.3  # via sphinx
 sphinxcontrib-jsmath==1.0.1  # via sphinx
-sphinxcontrib-qthelp==1.0.2  # via sphinx
-sphinxcontrib-serializinghtml==1.1.3  # via sphinx
-urllib3==1.25.3           # via requests
+sphinxcontrib-qthelp==1.0.3  # via sphinx
+sphinxcontrib-serializinghtml==1.1.4  # via sphinx
+urllib3==1.25.9           # via requests

requirements/static/py3.6/docs.txt

@@ -5,26 +5,26 @@
 #    pip-compile -o requirements/static/py3.6/docs.txt -v requirements/static/docs.in
 #
 alabaster==0.7.12         # via sphinx
-babel==2.7.0              # via sphinx
-certifi==2019.3.9         # via requests
+babel==2.8.0              # via sphinx
+certifi==2020.4.5.1       # via requests
 chardet==3.0.4            # via requests
-docutils==0.14            # via sphinx
-idna==2.8                 # via requests
-imagesize==1.1.0          # via sphinx
-jinja2==2.10.1            # via sphinx
+docutils==0.16            # via sphinx
+idna==2.9                 # via requests
+imagesize==1.2.0          # via sphinx
+jinja2==2.11.2            # via sphinx
 markupsafe==1.1.1         # via jinja2
-packaging==19.0           # via sphinx
-pygments==2.4.2           # via sphinx
-pyparsing==2.4.0          # via packaging
-pytz==2019.1              # via babel
-requests==2.22.0          # via sphinx
-six==1.12.0               # via packaging
-snowballstemmer==1.2.1    # via sphinx
-sphinx==2.0.1
-sphinxcontrib-applehelp==1.0.1  # via sphinx
-sphinxcontrib-devhelp==1.0.1  # via sphinx
-sphinxcontrib-htmlhelp==1.0.2  # via sphinx
+packaging==20.3           # via sphinx
+pygments==2.6.1           # via sphinx
+pyparsing==2.4.7          # via packaging
+pytz==2019.3              # via babel
+requests==2.23.0          # via sphinx
+six==1.14.0               # via packaging
+snowballstemmer==2.0.0    # via sphinx
+sphinx==3.0.1
+sphinxcontrib-applehelp==1.0.2  # via sphinx
+sphinxcontrib-devhelp==1.0.2  # via sphinx
+sphinxcontrib-htmlhelp==1.0.3  # via sphinx
 sphinxcontrib-jsmath==1.0.1  # via sphinx
-sphinxcontrib-qthelp==1.0.2  # via sphinx
-sphinxcontrib-serializinghtml==1.1.3  # via sphinx
-urllib3==1.25.3           # via requests
+sphinxcontrib-qthelp==1.0.3  # via sphinx
+sphinxcontrib-serializinghtml==1.1.4  # via sphinx
+urllib3==1.25.9           # via requests

requirements/static/py3.7/docs.txt

@@ -5,26 +5,26 @@
 #    pip-compile -o requirements/static/py3.7/docs.txt -v requirements/static/docs.in
 #
 alabaster==0.7.12         # via sphinx
-babel==2.7.0              # via sphinx
-certifi==2019.3.9         # via requests
+babel==2.8.0              # via sphinx
+certifi==2020.4.5.1       # via requests
 chardet==3.0.4            # via requests
-docutils==0.14            # via sphinx
-idna==2.8                 # via requests
-imagesize==1.1.0          # via sphinx
-jinja2==2.10.1            # via sphinx
+docutils==0.16            # via sphinx
+idna==2.9                 # via requests
+imagesize==1.2.0          # via sphinx
+jinja2==2.11.2            # via sphinx
 markupsafe==1.1.1         # via jinja2
-packaging==19.0           # via sphinx
-pygments==2.4.2           # via sphinx
-pyparsing==2.4.0          # via packaging
-pytz==2019.1              # via babel
-requests==2.22.0          # via sphinx
-six==1.12.0               # via packaging
-snowballstemmer==1.2.1    # via sphinx
-sphinx==2.0.1
-sphinxcontrib-applehelp==1.0.1  # via sphinx
-sphinxcontrib-devhelp==1.0.1  # via sphinx
-sphinxcontrib-htmlhelp==1.0.2  # via sphinx
+packaging==20.3           # via sphinx
+pygments==2.6.1           # via sphinx
+pyparsing==2.4.7          # via packaging
+pytz==2019.3              # via babel
+requests==2.23.0          # via sphinx
+six==1.14.0               # via packaging
+snowballstemmer==2.0.0    # via sphinx
+sphinx==3.0.1
+sphinxcontrib-applehelp==1.0.2  # via sphinx
+sphinxcontrib-devhelp==1.0.2  # via sphinx
+sphinxcontrib-htmlhelp==1.0.3  # via sphinx
 sphinxcontrib-jsmath==1.0.1  # via sphinx
-sphinxcontrib-qthelp==1.0.2  # via sphinx
-sphinxcontrib-serializinghtml==1.1.3  # via sphinx
-urllib3==1.25.3           # via requests
+sphinxcontrib-qthelp==1.0.3  # via sphinx
+sphinxcontrib-serializinghtml==1.1.4  # via sphinx
+urllib3==1.25.9           # via requests