Added shortcuts to hyperlink downloads, source files, and issues

doc/conf.py

@@ -16,7 +16,7 @@ sys.path.extend([
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['saltdocs', 'sphinx.ext.autodoc']
+extensions = ['saltdocs', 'sphinx.ext.autodoc', 'sphinx.ext.extlinks']
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
@@ -82,6 +82,12 @@ pygments_style = 'sphinx'
 # A list of ignored prefixes for module index sorting.
 #modindex_common_prefix = []
 
+# A shortcut for linking to tickets on the GitHub issue tracker
+extlinks = {
+    'blob': ('https://github.com/thatch45/salt/blob/v%s/%%s' % __version__, None),
+    'download': ('https://github.com/downloads/thatch45/salt/%s', None),
+    'issue': ('https://github.com/thatch45/salt/issues/%s', 'issue '),
+}
 
 # -- Options for HTML output ---------------------------------------------------
 

doc/index.rst

@@ -71,7 +71,7 @@ Presentation at SLLUG in May 2011
 `video`_ | `slides`_ (PDF)
 
 .. _`video`: http://blip.tv/thomas-s-hatch/salt-0-8-7-presentation-5180182
-.. _`slides`: https://github.com/downloads/thatch45/salt/Salt.pdf
+.. _`slides`: :download:`Salt.pdf`
 
 Configuration and CLI Usage
 ---------------------------

doc/ref/grains.rst

@@ -35,4 +35,4 @@ Examples of Grains
 The core module in the grains package is where the main grains are loaded by
 the salt minion and the principal example of how to write grains:
 
-https://github.com/thatch45/salt/blob/master/salt/grains/core.py
+:blob:`salt/grains/core.py`

doc/ref/index.rst

@@ -35,7 +35,7 @@ Minion Execution Modules
 The minion execution modules or just ``modules`` are the core to what salt is
 and does. These modules are found in:
 
-https://github.com/thatch45/salt/tree/master/salt/modules
+:blob:`salt/modules`
 
 These modules are what is called by the salt command line and the salt client
 api. Adding modules is done by simply adding additional python modules to the
@@ -54,7 +54,7 @@ of execution modules and types to specific salt minions.
 
 The code used to generate the Salt grains can be found here:
 
-https://github.com/thatch45/salt/tree/master/salt/grains
+:blob:`salt/grains`
 
 States
 ``````
@@ -64,7 +64,7 @@ solution for system configuration management.
 
 States can be easily added to Salt by dropping a new state module in:
 
-https://github.com/thatch45/salt/tree/master/salt/states
+:blob:`salt/states`
 
 Renderers
 `````````
@@ -77,7 +77,7 @@ it.
 
 The existing renderers can be found here:
 
-https://github.com/thatch45/salt/tree/master/salt/renderers
+:blob:`salt/renderers`
 
 Returners
 `````````
@@ -89,7 +89,7 @@ from an SQL or NOSQL database, to a custom application made to use Salt.
 
 The existing returners can be found here:
 
-https://github.com/thatch45/salt/tree/master/salt/returners
+:blob:`salt/returners`
 
 Runners
 ```````
@@ -101,4 +101,4 @@ act as a generic interface for encapsulating master side executions.
 
 Existing Salt runners are located here:
 
-https://github.com/thatch45/salt/tree/master/salt/runners
+:blob:`salt/runners`

doc/ref/modules/index.rst

@@ -147,9 +147,9 @@ regardless of what the actual module is named.
 
 The package manager modules are the best example of using the ``__virtual__``
 function:
-https://github.com/thatch45/salt/blob/master/salt/modules/pacman.py
-https://github.com/thatch45/salt/blob/master/salt/modules/yum.py
-https://github.com/thatch45/salt/blob/master/salt/modules/apt.py
+:blob:`salt/modules/pacman.py`
+:blob:`salt/modules/yum.py`
+:blob:`salt/modules/apt.py`
 
 Documentation
 =============
@@ -227,7 +227,7 @@ functions for salt, but to stand as examples for building out more Salt
 modules.
 
 The existing modules can be found here:
-https://github.com/thatch45/salt/tree/master/salt/modules
+:blob:`salt/modules`
 
 The most simple module is the test module, it contains the simplest salt
 function, test.ping:

doc/ref/renderers.rst

@@ -32,7 +32,7 @@ Examples
 The best place to find examples of renderers is in the Salt source code. The
 renderers included with Salt can be found here:
 
-https://github.com/thatch45/salt/blob/master/salt/renderers
+:blob:`salt/renderers`
 
 Here is a simple jinja + yaml example:
 

doc/ref/returners/index.rst

@@ -58,4 +58,4 @@ Examples
 --------
 
 The collection of builtin salt returners can be found here:
-https://github.com/thatch45/salt/tree/master/salt/returners
+:blob:`salt/returners`

doc/ref/runners.rst

@@ -30,7 +30,7 @@ Examples
 
 The best examples of runners can be found in the Salt source:
 
-https://github.com/thatch45/salt/blob/master/salt/runners
+:blob:`salt/runners`
 
 A simple runner that returns a well formated list of the minons that are
 responding to salt calls would look like this:

doc/ref/states/index.rst

@@ -158,7 +158,7 @@ files.
 The available renderers can be found in the renderers directory in the Salt
 source code:
 
-https://github.com/thatch45/salt/tree/master/salt/renderers
+:blob:`salt/renderers`
 
 By default sls files are rendered using jinja as a templating engine, and yaml
 as the serialization format. Since the rendering system can be extended simply

doc/topics/download.rst

@@ -59,11 +59,11 @@ still have issues, these backports may help
 
 ZeroMQ backport:
 
-https://github.com/downloads/thatch45/salt/zeromq-2.1.7-1.el6.x86_64.rpm
+:download:`zeromq-2.1.7-1.el6.x86_64.rpm`
 
 PyZMQ bindings backport:
 
-https://github.com/downloads/thatch45/salt/python-zmq-2.1.7-1.el6.src.rpm
+:download:`python-zmq-2.1.7-1.el6.src.rpm`
 
 Package to set up EPEL repository (provided by the EPEL project):
 
@@ -81,19 +81,19 @@ dependencies:
 
 Salt rpm:
 
-https://github.com/downloads/thatch45/salt/salt-0.8.9-1.el5.noarch.rpm
+:download:`salt-0.8.9-1.el5.noarch.rpm`
 
 YAML bindings for python 2.6:
 
-https://github.com/downloads/thatch45/salt/python26-PyYAML-3.08-4.el5.x86_64.rpm
+:download:`python26-PyYAML-3.08-4.el5.x86_64.rpm`
 
 ZeroMQ backport:
 
-https://github.com/downloads/thatch45/salt/zeromq-2.1.7-1.el5.x86_64.rpm
+:download:`zeromq-2.1.7-1.el5.x86_64.rpm`
 
 PyZMQ bindings backport:
 
-https://github.com/downloads/thatch45/salt/python26-zmq-2.1.7-1.el5.x86_64.rpm
+:download:`python26-zmq-2.1.7-1.el5.x86_64.rpm`
 
 Salt for Arch Linux
 -------------------

doc/topics/specs/salt_auth_proto_abs.rst

@@ -77,9 +77,9 @@ Source Files Implimenting Components
 ====================================
 
 The pubkey authentication is managed via the salt.master module:
-https://github.com/thatch45/salt/blob/master/salt/master.py
+:blob:`salt/master.py`
 The regular minion authentication is managed via the salt.crypt module:
-https://github.com/thatch45/salt/blob/master/salt/crypt.py
+:blob:`salt/crypt.py`
 The salt.crypt module contains a class "SAuth" that can be used for
 standalone authentication with the Salt master, this is most likely the best
 place to start when looking into how the authentication mechanism works