Browse code

change the policy wrt $ sudo docker to simplify auto-testing

Sven Dowideit authored on 2013/12/06 11:52:32
Showing 1 changed files
... ...
@@ -51,15 +51,15 @@ directory:
51 51
 ###Alternative Installation: Docker Container
52 52
 
53 53
 If you're running ``docker`` on your development machine then you may
54
-find it easier and cleaner to use the Dockerfile. This installs Sphinx
54
+find it easier and cleaner to use the docs Dockerfile. This installs Sphinx
55 55
 in a container, adds the local ``docs/`` directory and builds the HTML
56 56
 docs inside the container, even starting a simple HTTP server on port
57
-8000 so that you can connect and see your changes. Just run ``docker
58
-build .`` and run the resulting image. This is the equivalent to
59
-``make clean server`` since each container starts clean.
57
+8000 so that you can connect and see your changes.
60 58
 
61
-In the ``docs/`` directory, run:
62
-    ```docker build -t docker:docs . && docker run -p 8000:8000 docker:docs```
59
+In the ``docker`` source directory, run:
60
+    ```make doc```
61
+
62
+This is the equivalent to ``make clean server`` since each container starts clean.
63 63
 
64 64
 Usage
65 65
 -----
... ...
@@ -128,7 +128,8 @@ Guides on using sphinx
128 128
 
129 129
 * Code examples
130 130
 
131
-  * Start without $, so it's easy to copy and paste.
131
+  * Start typed commands with ``$ `` (dollar space) so that they 
132
+    are easily differentiated from program output.
132 133
   * Use "sudo" with docker to ensure that your command is runnable
133 134
     even if they haven't [used the *docker*
134 135
     group](http://docs.docker.io/en/latest/use/basics/#why-sudo).