| ... | ... |
@@ -39,4 +39,36 @@ Notes |
| 39 | 39 |
* The index.html and gettingstarted.html files are copied from the source dir to the output dir without modification. |
| 40 | 40 |
So changes to those pages should be made directly in html |
| 41 | 41 |
* For the template the css is compiled from less. When changes are needed they can be compiled using |
| 42 |
-lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css`` |
|
| 43 | 42 |
\ No newline at end of file |
| 43 |
+lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css`` |
|
| 44 |
+ |
|
| 45 |
+ |
|
| 46 |
+Guides on using sphinx |
|
| 47 |
+---------------------- |
|
| 48 |
+* To make links to certain pages create a link target like so: |
|
| 49 |
+ |
|
| 50 |
+ ``` |
|
| 51 |
+ .. _hello_world: |
|
| 52 |
+ |
|
| 53 |
+ Hello world |
|
| 54 |
+ =========== |
|
| 55 |
+ |
|
| 56 |
+ This is.. (etc.) |
|
| 57 |
+ ``` |
|
| 58 |
+ |
|
| 59 |
+ The ``_hello_world:`` will make it possible to link to this position (page and marker) from all other pages. |
|
| 60 |
+ |
|
| 61 |
+* Notes, warnings and alarms |
|
| 62 |
+ |
|
| 63 |
+ ``` |
|
| 64 |
+ # a note (use when something is important) |
|
| 65 |
+ .. note:: |
|
| 66 |
+ |
|
| 67 |
+ # a warning (orange) |
|
| 68 |
+ .. warning:: |
|
| 69 |
+ |
|
| 70 |
+ # danger (red, use sparsely) |
|
| 71 |
+ .. danger:: |
|
| 72 |
+ |
|
| 73 |
+* Code examples |
|
| 74 |
+ |
|
| 75 |
+ Start without $, so it's easy to copy and paste. |
|
| 44 | 76 |
\ No newline at end of file |
| ... | ... |
@@ -1,4 +1,4 @@ |
| 1 | 1 |
|
| 2 |
-.. warning:: |
|
| 2 |
+.. note:: |
|
| 3 | 3 |
|
| 4 |
- This example assumes that you have Docker running in daemon mode. For more information please see :ref:`running_examples` |
|
| 5 | 4 |
\ No newline at end of file |
| 5 |
+ This example assumes you have Docker running in daemon mode. For more information please see :ref:`running_examples` |
| ... | ... |
@@ -9,7 +9,7 @@ Hello World |
| 9 | 9 |
|
| 10 | 10 |
.. include:: example_header.inc |
| 11 | 11 |
|
| 12 |
-This is the most basic example available for using Docker. The example assumes you have Docker installed. |
|
| 12 |
+This is the most basic example available for using Docker. |
|
| 13 | 13 |
|
| 14 | 14 |
Download the base container |
| 15 | 15 |
|
| ... | ... |
@@ -7,26 +7,27 @@ |
| 7 | 7 |
Running The Examples |
| 8 | 8 |
-------------------- |
| 9 | 9 |
|
| 10 |
-There are two ways to run docker, daemon and standalone mode. |
|
| 10 |
+There are two ways to run docker, daemon mode and standalone mode. |
|
| 11 | 11 |
|
| 12 |
-When you run the docker command it will first check to see if there is already a docker daemon running in the background it can connect too, and if so, it will use that daemon to run all of the commands. |
|
| 12 |
+When you run the docker command it will first check if there is a docker daemon running in the background it can connect to. |
|
| 13 | 13 |
|
| 14 |
-If there is no daemon then docker will run in standalone mode. |
|
| 14 |
+* If it exists it will use that daemon to run all of the commands. |
|
| 15 |
+* If it does not exist docker will run in standalone mode (docker will exit after each command). |
|
| 15 | 16 |
|
| 16 |
-Docker needs to be run from a privileged account (root). Depending on which mode you are using, will determine how you need to execute docker. |
|
| 17 |
+Docker needs to be run from a privileged account (root). |
|
| 17 | 18 |
|
| 18 |
-1. The most common way is to run a docker daemon as root in the background, and then connect to it from the docker client from any account. |
|
| 19 |
+1. The most common (and recommended) way is to run a docker daemon as root in the background, and then connect to it from the docker client from any account. |
|
| 19 | 20 |
|
| 20 |
- .. code-block:: bash |
|
| 21 |
+ .. code-block:: bash |
|
| 21 | 22 |
|
| 22 |
- # starting docker daemon in the background |
|
| 23 |
- $ sudo docker -d & |
|
| 24 |
- |
|
| 25 |
- # now you can run docker commands from any account. |
|
| 26 |
- $ docker <command> |
|
| 23 |
+ # starting docker daemon in the background |
|
| 24 |
+ sudo docker -d & |
|
| 25 |
+ |
|
| 26 |
+ # now you can run docker commands from any account. |
|
| 27 |
+ docker <command> |
|
| 27 | 28 |
|
| 28 | 29 |
2. Standalone: You need to run every command as root, or using sudo |
| 29 | 30 |
|
| 30 |
- .. code-block:: bash |
|
| 31 |
+ .. code-block:: bash |
|
| 31 | 32 |
|
| 32 |
- $ sudo docker <command> |
|
| 33 |
+ sudo docker <command> |
| ... | ... |
@@ -82,7 +82,7 @@ h4 {
|
| 82 | 82 |
.btn-custom {
|
| 83 | 83 |
background-color: #292929 !important; |
| 84 | 84 |
background-repeat: repeat-x; |
| 85 |
- filter: progid:dximagetransform.microsoft.gradient(startColorstr="#515151", endColorstr="#282828"); |
|
| 85 |
+ filter: progid:DXImageTransform.Microsoft.gradient(startColorstr="#515151", endColorstr="#282828"); |
|
| 86 | 86 |
background-image: -khtml-gradient(linear, left top, left bottom, from(#515151), to(#282828)); |
| 87 | 87 |
background-image: -moz-linear-gradient(top, #515151, #282828); |
| 88 | 88 |
background-image: -ms-linear-gradient(top, #515151, #282828); |
| ... | ... |
@@ -131,6 +131,27 @@ section.header {
|
| 131 | 131 |
margin: 15px 15px 15px 0; |
| 132 | 132 |
border: 2px solid gray; |
| 133 | 133 |
} |
| 134 |
+.admonition {
|
|
| 135 |
+ padding: 10px; |
|
| 136 |
+ border: 1px solid grey; |
|
| 137 |
+ margin-bottom: 10px; |
|
| 138 |
+ margin-top: 10px; |
|
| 139 |
+ -webkit-border-radius: 4px; |
|
| 140 |
+ -moz-border-radius: 4px; |
|
| 141 |
+ border-radius: 4px; |
|
| 142 |
+} |
|
| 143 |
+.admonition .admonition-title {
|
|
| 144 |
+ font-weight: bold; |
|
| 145 |
+} |
|
| 146 |
+.admonition.note {
|
|
| 147 |
+ background-color: #f1ebba; |
|
| 148 |
+} |
|
| 149 |
+.admonition.warning {
|
|
| 150 |
+ background-color: #eed9af; |
|
| 151 |
+} |
|
| 152 |
+.admonition.danger {
|
|
| 153 |
+ background-color: #e9bcab; |
|
| 154 |
+} |
|
| 134 | 155 |
/* =================== |
| 135 | 156 |
left navigation |
| 136 | 157 |
===================== */ |
| ... | ... |
@@ -179,7 +179,33 @@ section.header {
|
| 179 | 179 |
border: 2px solid gray; |
| 180 | 180 |
} |
| 181 | 181 |
|
| 182 |
+.admonition {
|
|
| 183 |
+ padding: 10px; |
|
| 184 |
+ border: 1px solid grey; |
|
| 185 |
+ |
|
| 186 |
+ margin-bottom: 10px; |
|
| 187 |
+ margin-top: 10px; |
|
| 188 |
+ |
|
| 189 |
+ -webkit-border-radius: 4px; |
|
| 190 |
+ -moz-border-radius: 4px; |
|
| 191 |
+ border-radius: 4px; |
|
| 192 |
+} |
|
| 193 |
+ |
|
| 194 |
+.admonition .admonition-title {
|
|
| 195 |
+ font-weight: bold; |
|
| 196 |
+} |
|
| 197 |
+ |
|
| 198 |
+.admonition.note {
|
|
| 199 |
+ background-color: rgb(241, 235, 186); |
|
| 200 |
+} |
|
| 182 | 201 |
|
| 202 |
+.admonition.warning {
|
|
| 203 |
+ background-color: rgb(238, 217, 175); |
|
| 204 |
+} |
|
| 205 |
+ |
|
| 206 |
+.admonition.danger {
|
|
| 207 |
+ background-color: rgb(233, 188, 171); |
|
| 208 |
+} |
|
| 183 | 209 |
|
| 184 | 210 |
/* =================== |
| 185 | 211 |
left navigation |