Remove more ":doc:" references from doc/* files

doc/contents.rst

@@ -1,3 +1,5 @@
+.. _table-of-contents:
+
 ======================
 Salt Table of Contents
 ======================

doc/ref/cli/salt.rst

@@ -1,3 +1,5 @@
+.. _ref-cli-salt:
+
 ========
 ``salt``
 ========

doc/ref/runners/index.rst

@@ -1,3 +1,5 @@
+.. _runners:
+
 =======
 Runners
 =======

doc/ref/states/index.rst

@@ -1,3 +1,5 @@
+.. _state-system-reference:
+
 ======================
 State System Reference
 ======================
@@ -25,7 +27,7 @@ configure and manage a few servers or a few thousand servers. It allows
 configurations to be kept under version control.
 
 Salt States is an extension of the Salt Modules that we discussed in the
-previous :doc:`remote execution </topics/tutorials/modules>` tutorial. Instead
+previous :ref:`remote execution <tutorial-remote-execution-modules>` tutorial. Instead
 of calling one-off executions the state of a system can be easily defined and
 then enforced.
 
@@ -39,7 +41,7 @@ an understanding of Salt states and how to write the states is needed as well.
 .. note::
 
     States are compiled and executed only on minions that have been targeted.
-    To execute functions directly on masters, see :doc:`runners </ref/runners/index>`.
+    To execute functions directly on masters, see :ref:`runners <runners>`.
 
 Salt SLS System
 ---------------

doc/ref/states/providers.rst

@@ -1,3 +1,5 @@
+.. _state-providers:
+
 ===============
 State Providers
 ===============

doc/topics/proxyminion/demo.rst

@@ -1,3 +1,5 @@
+.. _proxy-minion-end-to-end-example:
+
 ====================================
 Salt Proxy Minion End-to-End Example
 ====================================

doc/topics/ssh/index.rst

@@ -155,7 +155,7 @@ systems still need to be implemented.
     By default, Grains are settable through ``salt-ssh``. By
     default, these grains will *not* be persisted across reboots.
 
-    See the "thin_dir" setting in :doc:`Roster documentation </topics/ssh/roster>`
+    See the "thin_dir" setting in :ref:`Roster documentation <ssh-roster>`
     for more details.
 
 Configuring Salt SSH
@@ -167,7 +167,7 @@ the ``-c`` option to Salt SSH facilitates passing in a directory to look inside
 configuration file named ``master``.
 
 Minion Config
----------------
+-------------
 
 .. versionadded:: 2015.5.1
 

doc/topics/states/index.rst

@@ -18,14 +18,14 @@ resources to learn more about state and renderers.
         Contains: list of install packages, create users, transfer files, start
         services, and so on.
 
-    :doc:`Pillar System <../pillar/index>`
+    :ref:`Pillar System <pillar>`
         Contains: description of Salt's Pillar system.
 
-    :doc:`Highstate data structure <../../ref/states/highstate>`
+    :ref:`Highstate data structure <states-highstate>`
         Contains: a dry vocabulary and technical representation of the
         configuration format that states represent.
 
-    :doc:`Writing states <../../ref/states/writing>`
+    :ref:`Writing states <state-modules>`
         Contains: a guide on how to write Salt state modules, easily extending
         Salt to directly manage more software.
 
@@ -40,13 +40,13 @@ resources to learn more about state and renderers.
     templating engines, or files. Salt's configuration management system is,
     under the hood, language agnostic.
 
-    :doc:`Full list of renderers <../../ref/renderers/all/index>`
+    :ref:`Full list of renderers <all-salt.renderers>`
         Contains: a list of renderers.
         YAML is one choice, but many systems are available, from
         alternative templating engines to the PyDSL language for rendering
         sls formulas.
 
-    :doc:`Renderers <../../ref/renderers/index>`
+    :ref:`Renderers <renderers>`
         Contains: more information about renderers. Salt states are only
         concerned with the ultimate highstate data structure, not how the
         data structure was created.

doc/topics/targeting/globbing.rst

@@ -68,7 +68,7 @@ Match the ``web-x``, ``web-y``, and ``web-z`` minions:
 .. note::
 
     For additional targeting methods please review the
-    :doc:`compound matchers </topics/targeting/compound>` documentation.
+    :ref:`compound matchers <targeting-compound>` documentation.
 
 
 Regular Expressions

doc/topics/targeting/nodegroups.rst

@@ -5,7 +5,7 @@ Node groups
 ===========
 
 Nodegroups are declared using a compound target specification. The compound
-target documentation can be found :doc:`here <compound>`.
+target documentation can be found :ref:`here <targeting-compound>`.
 
 The :conf_master:`nodegroups` master config file parameter is used to define
 nodegroups. Here's an example nodegroup configuration within
@@ -25,8 +25,8 @@ nodegroups. Here's an example nodegroup configuration within
 .. note::
 
     The ``L`` within group1 is matching a list of minions, while the ``G`` in
-    group2 is matching specific grains. See the :doc:`compound matchers
-    <compound>` documentation for more details.
+    group2 is matching specific grains. See the :ref:`compound matchers
+    <targeting-compound>` documentation for more details.
 
 .. versionadded:: 2015.8.0
 

doc/topics/topology/syndic.rst

@@ -76,7 +76,7 @@ Syndic with Multimaster lets you connect a syndic to multiple masters to provide
 an additional layer of redundancy in a syndic configuration.
 
 Higher level masters should first be configured in a multimaster configuration.
-See :doc:`Multimaster Tutorial </topics/tutorials/multimaster>`.
+See :ref:`Multimaster Tutorial <tutorial-multi-master>`.
 
 On the syndic, the :conf_master:`syndic_master` option is populated with
 a list of the higher level masters.

doc/topics/troubleshooting/index.rst

@@ -64,7 +64,7 @@ You can check port connectivity from the minion with the nc command:
   nc -v -z salt.master.ip 4505
   nc -v -z salt.master.ip 4506
 
-There is also a :doc:`firewall configuration</topics/tutorials/firewall>`
+There is also a :ref:`firewall configuration<firewall>`
 document that might help as well.
 
 If you've enabled the right TCP ports on your operating system or Linux
@@ -100,8 +100,8 @@ verbosity, increase the loglevel using the ``-l`` argument:
 The main difference between using ``salt`` and using ``salt-call`` is that
 ``salt-call`` is run from the minion, and it only runs the selected function on
 that minion. By contrast, ``salt`` is run from the master, and requires you to
-specify the minions on which to run the command using salt's :doc:`targeting
-system </topics/targeting/index>`.
+specify the minions on which to run the command using salt's :ref:`targeting
+system <targeting>`.
 
 Too many open files
 ===================
@@ -260,6 +260,6 @@ backwards compatible as possible.
 Debugging the Master and Minion
 ===============================
 
-A list of common :doc:`master</topics/troubleshooting/master>` and
-:doc:`minion</topics/troubleshooting/minion>` troubleshooting steps provide a
+A list of common :ref:`master<troubleshooting-salt-master>` and
+:ref:`minion<troubleshooting-minion-salt-call>` troubleshooting steps provide a
 starting point for resolving issues you may encounter.

doc/topics/troubleshooting/master.rst

@@ -1,3 +1,5 @@
+.. _troubleshooting-salt-master:
+
 ===============================
 Troubleshooting the Salt Master
 ===============================
@@ -27,8 +29,8 @@ What Ports does the Master Need Open?
 For the master, TCP ports 4505 and 4506 need to be open. If you've put both
 your Salt master and minion in debug mode and don't see an acknowledgment
 that your minion has connected, it could very well be a firewall interfering
-with the connection. See our :doc:`firewall configuration
-</topics/tutorials/firewall>` page for help opening the firewall on various
+with the connection. See our :ref:`firewall configuration
+<firewall>` page for help opening the firewall on various
 platforms.
 
 If you've opened the correct TCP ports and still aren't seeing connections,

doc/topics/troubleshooting/minion.rst

@@ -28,8 +28,8 @@ What Ports does the Minion Need Open?
 No ports need to be opened on the minion, as it makes outbound connections to
 the master. If you've put both your Salt master and minion in debug mode and
 don't see an acknowledgment that your minion has connected, it could very well
-be a firewall interfering with the connection. See our :doc:`firewall
-configuration </topics/tutorials/firewall>` page for help opening the firewall
+be a firewall interfering with the connection. See our :ref:`firewall
+configuration <firewall>` page for help opening the firewall
 on various platforms.
 
 If you have netcat installed, you can check port connectivity from the minion
@@ -90,8 +90,8 @@ even more verbosity, increase the loglevel using the ``-l`` argument:
 The main difference between using ``salt`` and using ``salt-call`` is that
 ``salt-call`` is run from the minion, and it only runs the selected function on
 that minion. By contrast, ``salt`` is run from the master, and requires you to
-specify the minions on which to run the command using salt's :doc:`targeting
-system </topics/targeting/index>`.
+specify the minions on which to run the command using salt's :ref:`targeting
+system <targeting>`.
 
 Live Python Debug Output
 ========================

doc/topics/troubleshooting/yaml_idiosyncrasies.rst

@@ -41,7 +41,7 @@ Nested Dictionaries
 When :ref:`dicts <python2:typesmapping>` are nested within other data
 structures (particularly lists), the indentation logic sometimes changes.
 Examples of where this might happen include ``context`` and ``default`` options
-from the :doc:`file.managed </ref/states/all/salt.states.file>` state:
+from the :mod:`file.managed <salt.states.file>` state:
 
 .. code-block:: yaml
 

doc/topics/tutorials/cloud_controller.rst

@@ -1,3 +1,5 @@
+.. _cloud-controller:
+
 ==========================
 Salt as a Cloud Controller
 ==========================
@@ -122,7 +124,7 @@ on the hypervisor and is bridged to an active network device.
     To use more advanced networking in Salt Virt, read the `Salt Virt
     Networking` document:
 
-    :doc:`Salt Virt Networking </topics/virt/nic>`
+    :ref:`Salt Virt Networking <vm-nic-profiles>`
 
 Libvirt State
 -------------
@@ -266,7 +268,7 @@ opened on hypervisors:
 
     More in-depth information regarding distribution specific firewall settings can read in:
 
-    :doc:`Opening the Firewall up for Salt </topics/tutorials/firewall>`
+    :ref:`Opening the Firewall up for Salt <firewall>`
 
 Salt also needs an additional flag to be turned on as well. The ``virt.tunnel``
 option needs to be turned on. This flag tells Salt to run migrations securely

doc/topics/tutorials/cron.rst

@@ -1,3 +1,5 @@
+.. _tutorial-cron-with-salt:
+
 Using cron with Salt
 ====================
 

doc/topics/tutorials/esky.rst

@@ -1,3 +1,5 @@
+.. _tutorial-esky:
+
 ======================================
 Automatic Updates / Frozen Deployments
 ======================================

doc/topics/tutorials/esxi_proxy_minion.rst

@@ -9,12 +9,12 @@ ESXi Proxy Minion
 .. note::
 
     This tutorial assumes basic knowledge of Salt. To get up to speed, check
-    out the :doc:`Salt Walkthrough </topics/tutorials/walkthrough>`.
+    out the :ref:`Salt Walkthrough <tutorial-salt-walk-through>`.
 
     This tutorial also assumes a basic understanding of Salt Proxy Minions. If
     you're unfamiliar with Salt's Proxy Minion system, please read the
-    :doc:`Salt Proxy Minion </topics/proxyminion/index>` documentation and the
-    :doc:`Salt Proxy Minion End-to-End Example </topics/proxyminion/demo>`
+    :ref:`Salt Proxy Minion <proxy-minion>` documentation and the
+    :ref:`Salt Proxy Minion End-to-End Example <proxy-minion-end-to-end-example>`
     tutorial.
 
     The third assumption that this tutorial makes is that you also have a
@@ -33,7 +33,7 @@ proxy process that "proxies" communication from the Salt Master to the ESXi host
 The master does not know or care that the ESXi target is not a "real" Salt Minion.
 
 More in-depth conceptual reading on Proxy Minions can be found in the
-:doc:`Proxy Minion </topics/proxyminion/index>` section of Salt's documentation.
+:ref:`Proxy Minion <proxy-minion>` section of Salt's documentation.
 
 Salt's ESXi Proxy Minion was added in the 2015.8.4 release of Salt.
 
@@ -210,9 +210,9 @@ one password in this list is required.
 The proxy integration will try the passwords listed in order. It is
 configured this way so you can have a regular password and the password you
 may be updating for an ESXi host either via the
-:doc:`vsphere.update_host_password </ref/modules/all/salt.modules.vsphere>`
+:mod:`vsphere.update_host_password <salt.modules.vsphere.update_host_password>`
 execution module function or via the
-:doc:`esxi.password_present </ref/modules/all/salt.states.esxi>` state
+:mod:`esxi.password_present <salt.states.esxi.password_present>` state
 function. This way, after the password is changed, you should not need to
 restart the proxy minion--it should just pick up the the new password
 provided in the list. You can then change pillar at will to move that
@@ -401,7 +401,7 @@ state commands against the ESXi host via a Proxy Minion: the
 vSphere Execution Module
 ------------------------
 
-The :doc:`Salt.modules.vsphere </ref/modules/all/salt.modules.vsphere>` is a
+The :mod:`Salt.modules.vsphere <salt.modules.vsphere>` is a
 standard Salt execution module that does the bulk of the work for the ESXi Proxy
 Minion. If you pull up the docs for it you'll see that almost every function in
 the module takes credentials (``username`` and ``password``) and a target ``host``
@@ -423,7 +423,7 @@ ESXi Execution Module
 
 In order for the Pillar information set up in the `Configuration`_ section above to
 be passed to the function call in the vSphere Execution Module, the
-:doc:`salt.modules.esxi </ref/modules/all/salt.modules.esxi>` execution module acts
+:mod:`salt.modules.esxi <salt.modules.esxi>` execution module acts
 as a "shim" between the vSphere execution module functions and the proxy process.
 
 The "shim" takes the authentication credentials specified in the Pillar files and
@@ -437,8 +437,8 @@ Proxy Minion.
 
 Because of the presence of the shim, to lookup documentation for what
 functions you can use to interface with the ESXi host, you'll want to
-look in :doc:`salt.modules.vsphere </ref/modules/all/salt.modules.vsphere>`
-instead of :doc:`salt.modules.esxi </ref/modules/all/salt.modules.esxi>`.
+look in :mod:`salt.modules.vsphere <salt.modules.vsphere>`
+instead of :mod:`salt.modules.esxi <salt.modules.esxi>`.
 
 
 Running Remote Execution Commands
@@ -463,7 +463,7 @@ The ESXi State Module functions similarly to other state modules. The "shim" pro
 by the `ESXi Execution Module`_ passes the necessary ``host``, ``username``, and
 ``password`` credentials through, so those options don't need to be provided in the
 state. Other than that, state files are written and executed just like any other
-Salt state. See the :doc:`salt.modules.esxi </ref/states/all/salt.states.esxi>` state
+Salt state. See the :mod:`salt.modules.esxi <salt.states.esxi>` state
 for ESXi state functions.
 
 The follow state file is an example of how to configure various pieces of an ESXi host
@@ -534,7 +534,7 @@ Relevant Salt Files and Resources
 - :mod:`ESXi Proxy Minion <salt.proxy.esxi>`
 - :mod:`ESXi Execution Module <salt.modules.esxi>`
 - :mod:`ESXi State Module <salt.states.esxi>`
-- :doc:`Salt Proxy Minion Docs </topics/proxyminion/index>`
-- :doc:`Salt Proxy Minion End-to-End Example </topics/proxyminion/demo>`
+- :ref:`Salt Proxy Minion Docs <proxy-minion>`
+- :ref:`Salt Proxy Minion End-to-End Example <proxy-minion-end-to-end-example>`
 - :mod:`vSphere Execution Module <salt.modules.vsphere>`
 

doc/topics/tutorials/gitfs.rst

@@ -7,7 +7,7 @@ Git Fileserver Backend Walkthrough
 .. note::
 
     This walkthrough assumes basic knowledge of Salt. To get up to speed, check
-    out the :doc:`Salt Walkthrough </topics/tutorials/walkthrough>`.
+    out the :ref:`Salt Walkthrough <tutorial-salt-walk-through>`.
 
 The gitfs backend allows Salt to serve files from git repositories. It can be
 enabled by adding ``git`` to the :conf_master:`fileserver_backend` list, and
@@ -853,8 +853,8 @@ for documentation.
 Why aren't my custom modules/states/etc. syncing to my Minions?
 ===============================================================
 
-In versions 0.16.3 and older, when using the :doc:`git fileserver backend
-</topics/tutorials/gitfs>`, certain versions of GitPython may generate errors
+In versions 0.16.3 and older, when using the :mod:`git fileserver backend
+<salt.fileserver.gitfs>`, certain versions of GitPython may generate errors
 when fetching, which Salt fails to catch. While not fatal to the fetch process,
 these interrupt the fileserver update that takes place before custom types are
 synced, and thus interrupt the sync itself. Try disabling the git fileserver

doc/topics/tutorials/halite.rst

@@ -1,3 +1,5 @@
+.. _tutorial-halite:
+
 =================================
 Installing and Configuring Halite
 =================================