Remove doc markup references from 2016.11 branch

This commit is contained in:
rallytime 2016-12-19 15:14:37 -07:00
parent 513058945c
commit c6e191ad0d
15 changed files with 30 additions and 24 deletions

View file

@ -1,3 +1,5 @@
.. _salt-extend:
===============
``salt-extend``
===============
@ -26,7 +28,7 @@ You can use Salt Extend to quickly create templated modules for adding new behav
Salt Extend takes a template directory and merges it into a SaltStack source code directory.
*See also*: :doc:`Salt Extend </topics/development/extend/index>`.
*See also*: :ref:`Salt Extend <development-salt-extend>`.
Options
=======

View file

@ -1,3 +1,5 @@
.. _salt-run:
============
``salt-run``
============

View file

@ -1,3 +1,5 @@
.. _development-salt-extend:
===========
Salt Extend
===========
@ -12,7 +14,7 @@ Salt Extend takes a template directory and merges it into a SaltStack source cod
Command line usage
~~~~~~~~~~~~~~~~~~
*See* :doc:`salt-extend </ref/cli/salt-extend>`
*See* :ref:`salt-extend <salt-extend>`
Choosing a template
~~~~~~~~~~~~~~~~~~~
@ -30,12 +32,12 @@ module_unit
Creates a new execution module unit test suite within tests/unit/modules/{{module_name}}_test.py
state
^^^^^^
^^^^^
Creates a new state module within salt/states/{{module_name}}.py
state_unit
^^^^^^^^^^^
^^^^^^^^^^
Creates a new state module unit test suite within tests/unit/states/{{module_name}}_test.py

View file

@ -36,7 +36,7 @@ for :mod:`Reclass <salt.tops.reclass_adapter>`.
master_tops:
varstack: /path/to/the/config/file/varstack.yaml
for :doc:`Varstack <../../ref/tops/all/salt.tops.varstack>`.
for :mod:`Varstack <salt.tops.varstack>`.
It's also possible to create custom master_tops modules. These modules must go
in a subdirectory called `tops` in the `extension_modules` directory.

View file

@ -1,3 +1,5 @@
.. _release-2016-11-0:
==============================================
Salt 2016.11.0 Release Notes - Codename Carbon
==============================================
@ -328,7 +330,7 @@ eAuth Changes
- External auth modules' ``auth`` method can return an ACL list for the given
username instead of ``True``. This list should be in the same format as
described in the :doc:`eAuth documentation </topics/eauth/index>`. It will be
described in the :ref:`eAuth documentation <acl-eauth>`. It will be
used for the user instead of one set in master config.
Example of the ``auth`` method return that allows a user to execute functions
@ -342,15 +344,15 @@ eAuth Changes
'@wheel',
'@runner']
- External auth is supported by :doc:`salt-run </ref/cli/salt-run>` and
:doc:`salt-key </ref/cli/salt-key>` now. Note that master must be started to
- External auth is supported by :ref:`salt-run <salt-run>` and
:ref:`salt-key <salt-key>` now. Note that master must be started to
use them with eAuth.
External Module Packaging
=========================
Modules may now be packaged via entry-points in setuptools. See
:doc:`external module packaging </topics/tutorials/packaging_modules>` tutorial
:ref:`external module packaging <tutorial-packaging-modules>` tutorial
for more information.
Functionality Changes

View file

@ -2,11 +2,10 @@
Salt 2016.11.1 Release Notes
============================
Version 2016.11.1 is a bugfix release for :doc:`2016.11.0
</topics/releases/2016.11.0>`.
Version 2016.11.1 is a bugfix release for :ref:`2016.11.0 <release-2016-11-0>`.
Changes for v2016.11.0..v2016.11.1
----------------------------------------------------------------
----------------------------------
Extended changelog courtesy of Todd Stansell (https://github.com/tjstansell/salt-changelogs):

View file

@ -2,5 +2,4 @@
Salt 2016.11.2 Release Notes
============================
Version 2016.11.2 is a bugfix release for :doc:`2016.11.0
</topics/releases/2016.11.0>`.
Version 2016.11.2 is a bugfix release for :ref:`2016.11.0 <release-2016-11-0>`.

View file

@ -5,7 +5,7 @@ Grains for Cisco NX OS Switches Proxy minions
.. versionadded: 2016.11.0
For documentation on setting up the nxos proxy minion look in the documentation
for :doc:`salt.proxy.nxos</ref/proxy/all/salt.proxy.nxos>`.
for :mod:`salt.proxy.nxos<salt.proxy.nxos>`.
'''
# Import Python Libs
from __future__ import absolute_import

View file

@ -5,7 +5,7 @@ Execution module for Cisco Network Services Orchestrator Proxy minions
.. versionadded: 2016.11.0
For documentation on setting up the cisconso proxy minion look in the documentation
for :doc:`salt.proxy.cisconso</ref/proxy/all/salt.proxy.cisconso>`.
for :mod:`salt.proxy.cisconso<salt.proxy.cisconso>`.
'''
from __future__ import absolute_import
@ -134,7 +134,7 @@ def apply_rollback(datastore, name):
def _proxy_cmd(command, *args, **kwargs):
'''
run commands from __proxy__
:doc:`salt.proxy.cisconso</ref/proxy/all/salt.proxy.cisconso>`
:mod:`salt.proxy.cisconso<salt.proxy.cisconso>`
command
function from `salt.proxy.cisconso` to run

View file

@ -36,7 +36,7 @@ def system_info():
def cmd(command, *args, **kwargs):
'''
run commands from __proxy__
:doc:`salt.proxy.nxos</ref/proxy/all/salt.proxy.nxos>`
:mod:`salt.proxy.nxos<salt.proxy.nxos>`
command
function from `salt.proxy.nxos` to run

View file

@ -55,7 +55,7 @@ the configuration of network devices via a NETCONF-compliant control plane.
Cisco Network Services Orchestrator.
More in-depth conceptual reading on Proxy Minions can be found in the
:doc:`Proxy Minion </topics/proxyminion/index>` section of Salt's
:ref:`Proxy Minion <proxy-minion>` section of Salt's
documentation.

View file

@ -44,7 +44,7 @@ key_accept
The functions from the proxy minion can be run from the salt commandline using
the :doc:`salt.modules.nxos</ref/modules/all/salt.modules.nxos>` execution module.
the :mod:`salt.modules.nxos<salt.modules.nxos>` execution module.
.. note::
The option `proxy_merge_grains_in_module: True` is required to have the NXOS

View file

@ -13,7 +13,7 @@ Manage the SNMP configuration on network devices.
Dependencies
------------
- :doc:`napalm snmp management module (salt.modules.napalm_snmp) </ref/modules/all/salt.modules.napalm_snmp>`
- :mod:`napalm snmp management module (salt.modules.napalm_snmp) <salt.modules.napalm_snmp>`
.. versionadded: 2016.11.0
'''

View file

@ -5,7 +5,7 @@ State module for Cisco NX OS Switches Proxy minions
.. versionadded: 2016.11.0
For documentation on setting up the nxos proxy minion look in the documentation
for :doc:`salt.proxy.nxos</ref/proxy/all/salt.proxy.nxos>`.
for :mod:`salt.proxy.nxos<salt.proxy.nxos>`.
'''
from __future__ import absolute_import
import re

View file

@ -4,9 +4,9 @@ Use `Varstack <https://github.com/conversis/varstack>` to provide tops data
.. |varstack| replace:: **varstack**
This :doc:`master_tops </topics/master_tops/index>` plugin provides access to
This :ref:`master_tops <master-tops-system>` plugin provides access to
the |varstack| hierarchical yaml files, so you can user |varstack| as a full
:doc:`external node classifier </ref/tops/all/salt.tops.ext_nodes.html>` and
:mod:`external node classifier <salt.tops.ext_nodes>` and
store state information (top data) in it.
Configuring Varstack