Browse Source

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

Andy Rothfusz 11 years ago
parent
commit
4194617bfe
2 changed files with 15 additions and 1 deletions
  1. 5 1
      docs/sources/conf.py
  2. 10 0
      docs/sources/use/builder.rst

+ 5 - 1
docs/sources/conf.py

@@ -40,7 +40,11 @@ html_additional_pages = {
 
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
-extensions = ['sphinxcontrib.httpdomain']
+extensions = ['sphinxcontrib.httpdomain', 'sphinx.ext.extlinks']
+
+# Configure extlinks
+extlinks = { 'issue': ('https://github.com/dotcloud/docker/issues/%s',
+	               'Issue ') }
 
 
 # Add any paths that contain templates here, relative to this directory.
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ['_templates']
 templates_path = ['_templates']

+ 10 - 0
docs/sources/use/builder.rst

@@ -116,6 +116,16 @@ core concepts of Docker where commits are cheap and containers can be
 created from any point in an image's history, much like source
 created from any point in an image's history, much like source
 control.
 control.
 
 
+Known Issues
+............
+
+* :issue:`783` is about file permissions problems that can occur when
+  using the AUFS file system. You might notice it during an attempt to
+  ``rm`` a file, for example. The issue describes a workaround.
+
+
+
+
 3.4 CMD
 3.4 CMD
 -------
 -------