Browse code

Add known issues to sections via new "issues" extension.

Andy Rothfusz authored on 2013/10/24 11:04:03
Showing 2 changed files
... ...
@@ -40,7 +40,11 @@ html_additional_pages = {
40 40
 
41 41
 # Add any Sphinx extension module names here, as strings. They can be extensions
42 42
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
43
-extensions = ['sphinxcontrib.httpdomain']
43
+extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.extlinks']
44
+
45
+# Configure extlinks
46
+extlinks = { 'issue': ('https://github.com/dotcloud/docker/issues/%s',
47
+	               'Issue ') }
44 48
 
45 49
 # Add any paths that contain templates here, relative to this directory.
46 50
 templates_path = ['_templates']
... ...
@@ -116,6 +116,16 @@ core concepts of Docker where commits are cheap and containers can be
116 116
 created from any point in an image's history, much like source
117 117
 control.
118 118
 
119
+Known Issues
120
+............
121
+
122
+* :issue:`783` is about file permissions problems that can occur when
123
+  using the AUFS file system. You might notice it during an attempt to
124
+  ``rm`` a file, for example. The issue describes a workaround.
125
+
126
+
127
+
128
+
119 129
 3.4 CMD
120 130
 -------
121 131