WIP re fabric#546. Stupid pickle.

bitprophet · bitprophet · commit cea36a193f0b · 2012-02-20T21:01:06.000-08:00
diff --git a/docs/conf.py b/docs/conf.py
@@ -79,6 +79,25 @@ def release_role(name, rawtext, text, lineno, inliner, options={}, content=[]):
     ], []
 roles.register_local_role('release', release_role)
 
+from docutils import nodes
+from sphinx import addnodes
+
+class env(nodes.literal):
+    pass
+
+# "Inline" extension to allow use of Sphinx-specific (vs docutils/ReST)
+# methods.
+def setup(app):
+    app.add_node(env)
+    # 'env' object type for Fabric env var referencing
+    # (not to be confused with Sphinx' builtin :envvar:)
+    app.add_object_type(
+        directivename='env',
+        rolename='env',
+        ref_nodeclass=env,
+        objname='Fabric env var',
+    )
+
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
diff --git a/docs/usage/env.rst b/docs/usage/env.rst
@@ -14,7 +14,7 @@ Environment as configuration
 ============================
 
 Most of Fabric's behavior is controllable by modifying env variables, such as
-``env.hosts`` (as seen in :ref:`the tutorial <defining-connections>`). Other
+:env:`hosts` (as seen in :ref:`the tutorial <defining-connections>`). Other
 commonly-modified env vars include:
 
 * ``user``: Fabric defaults to your local username when making SSH connections,
@@ -290,16 +290,13 @@ If ``True``, enables forwarding of your local SSH agent to the remote end.
 Set to the hostname part of ``env.host_string`` by ``fab``. For informational
 purposes only.
 
-.. _hosts:
+.. env:: hosts
 
-``hosts``
----------
-
-**Default:** ``[]``
+    **Default:** ``[]``
 
-The global host list used when composing per-task host lists.
+    The global host list used when composing per-task host lists.
 
-.. seealso:: :doc:`execution`
+    .. seealso:: :doc:`execution`
 
 .. _keepalive:
 
