From 73011c6bb035e2c13276929ddcd378ef45757028 Mon Sep 17 00:00:00 2001
From: "Brian C. Lane" <bcl@redhat.com>
Date: Wed, 14 Mar 2018 17:33:09 -0700
Subject: [PATCH] Update Sphinx documentation for composer.cli

---
 docs/Makefile              | 4 ++--
 docs/conf.py               | 4 ++--
 src/pylorax/api/compose.py | 4 ++--
 src/pylorax/api/recipes.py | 4 ++--
 src/pylorax/api/v0.py      | 2 +-
 5 files changed, 9 insertions(+), 9 deletions(-)

diff --git a/docs/Makefile b/docs/Makefile
index e0aa6f67..80c6277d 100644
--- a/docs/Makefile
+++ b/docs/Makefile
@@ -7,8 +7,8 @@ SPHINXBUILD   = sphinx-build
 SPHINXAPIDOC  = sphinx-apidoc
 PAPER         =
 BUILDDIR      = .
-SOURCEDIR     = ../src/pylorax
-MODULE_NAMES  = pylorax.rst pylorax.api.rst modules.rst
+SOURCEDIR     = ../src
+MODULE_NAMES  = pylorax.rst pylorax.api.rst modules.rst composer.rst composer.cli.rst
 
 # User-friendly check for sphinx-build
 ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
diff --git a/docs/conf.py b/docs/conf.py
index 964bf0f6..ce00f97a 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -50,7 +50,7 @@ master_doc = 'index'
 
 # General information about the project.
 project = u'Lorax'
-copyright = u'2017, Red Hat, Inc.'      # pylint: disable=redefined-builtin
+copyright = u'2018, Red Hat, Inc.'      # pylint: disable=redefined-builtin
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -280,7 +280,7 @@ texinfo_documents = [
 epub_title = u'Lorax'
 epub_author = u'Anaconda Team'
 epub_publisher = u'Anaconda Team'
-epub_copyright = u'2017, Red Hat, Inc.'
+epub_copyright = u'2018, Red Hat, Inc.'
 
 # The basename for the epub file. It defaults to the project name.
 #epub_basename = u'src'
diff --git a/src/pylorax/api/compose.py b/src/pylorax/api/compose.py
index adb34d8f..3c76362d 100644
--- a/src/pylorax/api/compose.py
+++ b/src/pylorax/api/compose.py
@@ -219,9 +219,9 @@ def start_build(cfg, yumlock, gitlock, branch, recipe_name, compose_type, test_m
 
 # Supported output types
 def compose_types(share_dir):
-    """ Returns a list of the supported output types
+    r""" Returns a list of the supported output types
 
-    The output types come from the kickstart names in /usr/share/lorax/composer/*ks
+    The output types come from the kickstart names in /usr/share/lorax/composer/\*ks
     """
     return [os.path.basename(ks)[:-3] for ks in glob(joinpaths(share_dir, "composer/*.ks"))]
 
diff --git a/src/pylorax/api/recipes.py b/src/pylorax/api/recipes.py
index de1e5f62..a7b2eb95 100644
--- a/src/pylorax/api/recipes.py
+++ b/src/pylorax/api/recipes.py
@@ -551,13 +551,13 @@ def commit_recipe_file(repo, branch, filename):
     return commit_recipe(repo, branch, recipe)
 
 def commit_recipe_directory(repo, branch, directory):
-    """Commit all *.toml files from a directory, if they aren't already in git.
+    r"""Commit all \*.toml files from a directory, if they aren't already in git.
 
     :param repo: Open repository
     :type repo: Git.Repository
     :param branch: Branch name
     :type branch: str
-    :param directory: The directory of *.toml recipes to commit
+    :param directory: The directory of \*.toml recipes to commit
     :type directory: str
     :returns: None
     :raises: Can raise errors from Ggit or RecipeFileError
diff --git a/src/pylorax/api/v0.py b/src/pylorax/api/v0.py
index a82abebf..4337de54 100644
--- a/src/pylorax/api/v0.py
+++ b/src/pylorax/api/v0.py
@@ -863,7 +863,7 @@ DELETE `/api/v0/compose/delete/<uuids>`
   UUID-logs.tar
 
 `/api/v0/compose/image/<uuid>`
-^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
   Returns the output image from the build. The filename is set to the filename
   from the build with the UUID as a prefix. eg. UUID-root.tar.xz or UUID-boot.iso.