From 7f0f4876d702deb5a6f9098446c7db203b912878 Mon Sep 17 00:00:00 2001 From: jamescott Date: Mon, 8 Dec 2014 14:44:31 -0800 Subject: [PATCH] add man page for chef-apply --- man_chef_apply/source/conf.py | 108 ++++++++++++++++++++++++++++++++ man_chef_apply/source/index.rst | 18 ++++++ 2 files changed, 126 insertions(+) create mode 100755 man_chef_apply/source/conf.py create mode 100644 man_chef_apply/source/index.rst diff --git a/man_chef_apply/source/conf.py b/man_chef_apply/source/conf.py new file mode 100755 index 0000000000..c6cb09752a --- /dev/null +++ b/man_chef_apply/source/conf.py @@ -0,0 +1,108 @@ +# -*- coding: utf-8 -*- +# +# Chef documentation build configuration file, created by +# sphinx-quickstart on Wed Feb 22 13:50:49 2012. +# +# Note that not all possible configuration values are present in this +# autogenerated file. +# +# All configuration values have a default; values that are commented out +# serve to show the default. + +import sys, os + +# If extensions (or modules to document with autodoc) are in another directory, +# add these directories to sys.path here. If the directory is relative to the +# documentation root, use os.path.abspath to make it absolute, like shown here. +#sys.path.insert(0, os.path.abspath('.')) + +# -- General configuration ----------------------------------------------------- + +# If your documentation needs a minimal Sphinx version, state it here. +#needs_sphinx = '1.0' + +# Add any Sphinx extension module names here, as strings. They can be extensions +# coming with Sphinx (named 'sphinx.ext.*') or your custom ones. +extensions = ['sphinx.ext.todo'] + +# Add any paths that contain templates here, relative to this directory. +templates_path = ['_templates'] + +# The suffix of source filenames. +source_suffix = '.rst' + +# The encoding of source files. +#source_encoding = 'utf-8-sig' + +# The master toctree document. +master_doc = 'index' + +# General information about the project. +project = u'chef-client' +# copyright = u'This work is licensed under a Creative Commons Attribution 3.0 Unported License' + +# The version info for the project you're documenting, acts as replacement for +# |version| and |release|, also used in various other places throughout the +# built documents. +# +# The short X.Y version. +#version = '0.0.0' +# The full version, including alpha/beta/rc tags. +#release = '0.0.0-0' + +# The language for content autogenerated by Sphinx. Refer to documentation +# for a list of supported languages. +#language = None + +# There are two options for replacing |today|: either, you set today to some +# non-false value, then it is used: +today = 'Chef 12.0' +# Else, today_fmt is used as the format for a strftime call. +#today_fmt = '%B %d, %Y' + +# List of patterns, relative to source directory, that match files and +# directories to ignore when looking for source files. +exclude_patterns = [] + +# The reST default role (used for this markup: `text`) to use for all documents. +#default_role = None + +# If true, '()' will be appended to :func: etc. cross-reference text. +#add_function_parentheses = True + +# If true, the current module name will be prepended to all description +# unit titles (such as .. function::). +#add_module_names = True + +# If true, sectionauthor and moduleauthor directives will be shown in the +# output. They are ignored by default. +#show_authors = False + +# The name of the Pygments (syntax highlighting) style to use. +pygments_style = 'emacs' + +# highlight_language = 'ruby' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + +# A string of reStructuredText that will be included at the beginning of every source file that is read. +rst_prolog = """ +.. include:: ../../swaps/swap_descriptions.txt +.. include:: ../../swaps/swap_names.txt +.. include:: ../../swaps/swap_notes.txt +""" + + +# -- Options for manual page output -------------------------------------------- + +# One entry per manual page. List of tuples +# (source start file, name, description, authors, manual section). +man_pages = [ + ('index', 'chef-apply', u'The man page for the chef-apply command line tool.', + [u'Chef'], 8) +] + +# If true, show URL addresses after external links. +#man_show_urls = False + diff --git a/man_chef_apply/source/index.rst b/man_chef_apply/source/index.rst new file mode 100644 index 0000000000..815cee1ccc --- /dev/null +++ b/man_chef_apply/source/index.rst @@ -0,0 +1,18 @@ +===================================================== +|chef apply| (executable) +===================================================== + +.. include:: ../../includes_ctl_chef_apply/includes_ctl_chef_apply.rst + +Options +===================================================== +.. include:: ../../includes_ctl_chef_apply/includes_ctl_chef_apply_options.rst + +Examples +===================================================== + +To use |chef apply| to run a recipe named ``machinations.rb``, enter the following: + +.. code-block:: bash + + $ chef-apply machinations.rb