Przeglądaj źródła

Merge pull request #3650 from tianon/fix-doc-man-generation

Fix docs man page generation and add Dockerfile man page
Andy Rothfusz 11 lat temu
rodzic
commit
6dfbbaa4ff
4 zmienionych plików z 9 dodań i 7 usunięć
  1. 1 1
      .travis.yml
  2. 2 2
      docs/Dockerfile
  3. 2 2
      docs/requirements.txt
  4. 4 2
      docs/sources/conf.py

+ 1 - 1
.travis.yml

@@ -25,6 +25,6 @@ before_script:
 script:
   - hack/travis/dco.py
   - hack/travis/gofmt.py
-  - make -sC docs SPHINXOPTS=-q docs # man
+  - make -sC docs SPHINXOPTS=-q docs man
 
 # vim:set sw=2 ts=2:

+ 2 - 2
docs/Dockerfile

@@ -8,8 +8,8 @@ MAINTAINER Nick Stinemates
 
 RUN apt-get update && DEBIAN_FRONTEND=noninteractive apt-get install -yq make python-pip python-setuptools
 # pip installs from docs/requirements.txt, but here to increase cacheability
-RUN pip install Sphinx==1.1.3
-RUN pip install sphinxcontrib-httpdomain==1.1.9
+RUN pip install Sphinx==1.2.1
+RUN pip install sphinxcontrib-httpdomain==1.2.0
 ADD . /docs
 RUN make -C /docs clean docs
 

+ 2 - 2
docs/requirements.txt

@@ -1,2 +1,2 @@
-Sphinx==1.1.3
-sphinxcontrib-httpdomain==1.1.9
+Sphinx==1.2.1
+sphinxcontrib-httpdomain==1.2.0

+ 4 - 2
docs/sources/conf.py

@@ -235,8 +235,10 @@ latex_documents = [
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
 man_pages = [
-    ('commandline/cli', 'docker', u'Docker Documentation',
-     [u'Team Docker'], 1)
+    ('reference/commandline/cli', 'docker', u'Docker CLI Documentation',
+     [u'Team Docker'], 1),
+    ('reference/builder', 'Dockerfile', u'Dockerfile Documentation',
+     [u'Team Docker'], 5),
 ]
 
 # If true, show URL addresses after external links.