* changed conf.py to reference toctree.rst instead of index
* Added note to README to upgrade your sphinx to the latest version to prevent a bug with .. note:: blocks.
| ... | ... |
@@ -39,8 +39,6 @@ When you need to add images, try to make them as small as possible (e.g. as gif) |
| 39 | 39 |
|
| 40 | 40 |
Notes |
| 41 | 41 |
----- |
| 42 |
-* The index.html and gettingstarted.html files are copied from the source dir to the output dir without modification. |
|
| 43 |
-So changes to those pages should be made directly in html |
|
| 44 | 42 |
* For the template the css is compiled from less. When changes are needed they can be compiled using |
| 45 | 43 |
lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css`` |
| 46 | 44 |
|
| ... | ... |
@@ -75,3 +73,6 @@ Guides on using sphinx |
| 75 | 75 |
* Code examples |
| 76 | 76 |
|
| 77 | 77 |
Start without $, so it's easy to copy and paste. |
| 78 |
+ |
|
| 79 |
+* To make the manpages, simply run 'make man'. Pleae note there is a bug in spinx 1.1.3 which makes this fail. |
|
| 80 |
+Upgrade to the latest version of sphinx. |
|
| 78 | 81 |
\ No newline at end of file |
| ... | ... |
@@ -203,7 +203,7 @@ latex_elements = {
|
| 203 | 203 |
# Grouping the document tree into LaTeX files. List of tuples |
| 204 | 204 |
# (source start file, target name, title, author, documentclass [howto/manual]). |
| 205 | 205 |
latex_documents = [ |
| 206 |
- ('index', 'Docker.tex', u'Docker Documentation',
|
|
| 206 |
+ ('toctree', 'Docker.tex', u'Docker Documentation',
|
|
| 207 | 207 |
u'Team Docker', 'manual'), |
| 208 | 208 |
] |
| 209 | 209 |
|
| ... | ... |
@@ -233,7 +233,7 @@ latex_documents = [ |
| 233 | 233 |
# One entry per manual page. List of tuples |
| 234 | 234 |
# (source start file, name, description, authors, manual section). |
| 235 | 235 |
man_pages = [ |
| 236 |
- ('index', 'docker', u'Docker Documentation',
|
|
| 236 |
+ ('toctree', 'docker', u'Docker Documentation',
|
|
| 237 | 237 |
[u'Team Docker'], 1) |
| 238 | 238 |
] |
| 239 | 239 |
|
| ... | ... |
@@ -247,7 +247,7 @@ man_pages = [ |
| 247 | 247 |
# (source start file, target name, title, author, |
| 248 | 248 |
# dir menu entry, description, category) |
| 249 | 249 |
texinfo_documents = [ |
| 250 |
- ('index', 'Docker', u'Docker Documentation',
|
|
| 250 |
+ ('toctree', 'Docker', u'Docker Documentation',
|
|
| 251 | 251 |
u'Team Docker', 'Docker', 'One line description of project.', |
| 252 | 252 |
'Miscellaneous'), |
| 253 | 253 |
] |
| ... | ... |
@@ -107,8 +107,8 @@ the image. This is functionally equivalent to running ``docker commit |
| 107 | 107 |
-run '{"Cmd": <command>}'`` outside the builder.
|
| 108 | 108 |
|
| 109 | 109 |
.. note:: |
| 110 |
- Don't confuse `RUN` with `CMD`. `RUN` actually runs a |
|
| 111 |
- command and commits the result; `CMD` does not execute anything at |
|
| 110 |
+ Don't confuse ``RUN`` with ``CMD``. ``RUN`` actually runs a |
|
| 111 |
+ command and commits the result; ``CMD`` does not execute anything at |
|
| 112 | 112 |
build time, but specifies the intended command for the image. |
| 113 | 113 |
|
| 114 | 114 |
3.5 EXPOSE |