From 03deebf0c1de67129b0145af0413eecd11cd2128 Mon Sep 17 00:00:00 2001 From: Tianon Gravi Date: Sat, 18 Jan 2014 10:07:02 -0700 Subject: [PATCH 1/4] Fix docs manpage generation Docker-DCO-1.1-Signed-off-by: Andrew Page (github: tianon) Upstream-commit: 10fc518fba8bf0f4a32cb1824664abfbacf5d884 Component: engine --- components/engine/docs/sources/conf.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/components/engine/docs/sources/conf.py b/components/engine/docs/sources/conf.py index c1480eb0c2..add50ce69c 100644 --- a/components/engine/docs/sources/conf.py +++ b/components/engine/docs/sources/conf.py @@ -235,8 +235,8 @@ 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), ] # If true, show URL addresses after external links. From cafba118e5301e2ae08eecc413fc5af00e6521c8 Mon Sep 17 00:00:00 2001 From: Tianon Gravi Date: Sat, 18 Jan 2014 10:07:32 -0700 Subject: [PATCH 2/4] Add Dockerfile man page generation from our Dockerfile reference page Docker-DCO-1.1-Signed-off-by: Andrew Page (github: tianon) Upstream-commit: 1c152f443df254e18d44790cd0dbfb6f6361e018 Component: engine --- components/engine/docs/sources/conf.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/components/engine/docs/sources/conf.py b/components/engine/docs/sources/conf.py index add50ce69c..12f5b57841 100644 --- a/components/engine/docs/sources/conf.py +++ b/components/engine/docs/sources/conf.py @@ -237,6 +237,8 @@ latex_documents = [ man_pages = [ ('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. From 38c688ffeb69feb2483258d08b7bf82a4de0b3b7 Mon Sep 17 00:00:00 2001 From: Tianon Gravi Date: Mon, 20 Jan 2014 11:29:24 -0700 Subject: [PATCH 3/4] Update Travis to also compile the man page(s) now that they compile properly again Docker-DCO-1.1-Signed-off-by: Andrew Page (github: tianon) Upstream-commit: 274863f221b55f2eb60fde7457e30998438a3f72 Component: engine --- components/engine/.travis.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/components/engine/.travis.yml b/components/engine/.travis.yml index 513fe70c18..8a43d9a462 100644 --- a/components/engine/.travis.yml +++ b/components/engine/.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: From 1c3b8811eaf8c2bc3384402784f1a1fddfe8f4e4 Mon Sep 17 00:00:00 2001 From: Tianon Gravi Date: Mon, 20 Jan 2014 12:29:55 -0700 Subject: [PATCH 4/4] Fix Travis build errors by bumping our python module versions to be newer See also https://bitbucket.org/birkenfeld/sphinx/issue/1281/sphinx-113-not-build-proper-manpages Docker-DCO-1.1-Signed-off-by: Andrew Page (github: tianon) Upstream-commit: 6ed9b06e072888d1e7bd60106f17371a89b668a4 Component: engine --- components/engine/docs/Dockerfile | 4 ++-- components/engine/docs/requirements.txt | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/components/engine/docs/Dockerfile b/components/engine/docs/Dockerfile index ae0fa85e0d..0d703c8c84 100644 --- a/components/engine/docs/Dockerfile +++ b/components/engine/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 diff --git a/components/engine/docs/requirements.txt b/components/engine/docs/requirements.txt index 095f7600cd..6f41142a84 100644 --- a/components/engine/docs/requirements.txt +++ b/components/engine/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