kotovalexarian-likes-github/moby--moby
1
0
Fork 0
mirror of https://github.com/moby/moby.git synced 2022-11-09 12:21:53 -05:00
Code Releases Activity

Enabled the docs to generate manpages.

Browse source 
* 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.
This commit is contained in:
Thatcher Peskens 2013-07-25 17:19:58 -07:00
parent 422378cb85
commit f4b63d9eea
3 changed files with 8 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/README.md
View file

@ -39,8 +39,6 @@ When you need to add images, try to make them as small as possible (e.g. as gif)
Notes Notes
----- -----
* The index.html and gettingstarted.html files are copied from the source dir to the output dir without modification.
So changes to those pages should be made directly in html
* For the template the css is compiled from less. When changes are needed they can be compiled using * For the template the css is compiled from less. When changes are needed they can be compiled using
lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css`` lessc ``lessc main.less`` or watched using watch-lessc ``watch-lessc -i main.less -o main.css``
@ -75,3 +73,6 @@ Guides on using sphinx
* Code examples * Code examples
Start without $, so it's easy to copy and paste. Start without $, so it's easy to copy and paste.
* To make the manpages, simply run 'make man'. Pleae note there is a bug in spinx 1.1.3 which makes this fail.
Upgrade to the latest version of sphinx.

6
docs/sources/conf.py
View file

@ -203,7 +203,7 @@ latex_elements = {
# Grouping the document tree into LaTeX files. List of tuples # Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]). # (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [ latex_documents = [
('index', 'Docker.tex', u'Docker Documentation', ('toctree', 'Docker.tex', u'Docker Documentation',
u'Team Docker', 'manual'), u'Team Docker', 'manual'),
] ]
@ -233,7 +233,7 @@ latex_documents = [
# One entry per manual page. List of tuples # One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section). # (source start file, name, description, authors, manual section).
man_pages = [ man_pages = [
('index', 'docker', u'Docker Documentation', ('toctree', 'docker', u'Docker Documentation',
[u'Team Docker'], 1) [u'Team Docker'], 1)
] ]
@ -247,7 +247,7 @@ man_pages = [
# (source start file, target name, title, author, # (source start file, target name, title, author,
# dir menu entry, description, category) # dir menu entry, description, category)
texinfo_documents = [ texinfo_documents = [
('index', 'Docker', u'Docker Documentation', ('toctree', 'Docker', u'Docker Documentation',
u'Team Docker', 'Docker', 'One line description of project.', u'Team Docker', 'Docker', 'One line description of project.',
'Miscellaneous'), 'Miscellaneous'),
] ]

4
docs/sources/use/builder.rst
View file

@ -107,8 +107,8 @@ the image. This is functionally equivalent to running ``docker commit
-run '{"Cmd": <command>}'`` outside the builder. -run '{"Cmd": <command>}'`` outside the builder.
.. note:: .. note::
Don't confuse `RUN` with `CMD`. `RUN` actually runs a Don't confuse ``RUN`` with ``CMD``. ``RUN`` actually runs a
command and commits the result; `CMD` does not execute anything at command and commits the result; ``CMD`` does not execute anything at
build time, but specifies the intended command for the image. build time, but specifies the intended command for the image.
3.5 EXPOSE 3.5 EXPOSE