From 522ab88d86741f61cbe8ebe1930fcbb2e70c5cce Mon Sep 17 00:00:00 2001
From: Stephen Finucane <stephen@that.guru>
Date: Thu, 4 May 2017 18:45:24 +0100
Subject: [PATCH] docs: Add example for modifying 'sys.path'

Signed-off-by: Stephen Finucane <stephen@that.guru>
Closes-Bug: #2
---
 docs/usage.rst | 38 ++++++++++++++++++++++++++++++++++++++
 1 file changed, 38 insertions(+)

diff --git a/docs/usage.rst b/docs/usage.rst
index f8d1b69..9966c61 100644
--- a/docs/usage.rst
+++ b/docs/usage.rst
@@ -69,3 +69,41 @@ output, add the ``show-nested`` flag.
     .. click:: hello_world:greet
       :prog: hello-world
       :show-nested:
+
+Modifying ``sys.path``
+----------------------
+
+If the application or script you wish to document is not installed (i.e. you
+have not installed it with `pip` or run ``python setup.py``), then you may need
+to modify ``sys.path``. For example, given the following application::
+
+    git
+      |- git
+      |    |- __init__.py
+      |    \- git.py
+      \- docs
+          |- git.rst
+          |- index.rst
+           \- conf.py
+
+then it would be necessary to add the following to ``git/docs/conf.py``:
+
+.. code-block:: python
+
+   import os
+   import sys
+   sys.path.insert(0, os.path.abspath('..'))
+
+Once done, you could include the following in ``git/docs/git.rst`` to document
+the application:
+
+.. code-block:: rst
+
+    .. click:: git.git:cli
+       :prog: git
+       :show-nested:
+
+assuming the group or command in ``git.git`` is named ``cli``.
+
+Refer to `issue #2 <https://github.com/click-contrib/sphinx-click/issues/2>`__
+for more information.