From 823cec005be2037e264dc0e252b8849876d45bf6 Mon Sep 17 00:00:00 2001 From: Derek Higgins Date: Wed, 16 Sep 2015 14:23:43 +0100 Subject: [PATCH] Add placeholder docs These are required to satisfy the gate-instack-undercloud-docs job. Content will need to be added over time. Change-Id: Id3057d7ee17f9e06afde382fea33b08dada3cb39 --- doc/source/conf.py | 125 +++++++++++++++++++++++++++++++++++++++++++ doc/source/index.rst | 3 ++ setup.cfg | 5 ++ tox.ini | 3 ++ 4 files changed, 136 insertions(+) create mode 100644 doc/source/conf.py create mode 100644 doc/source/index.rst diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 000000000..5a68ffe99 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,125 @@ +# -*- coding: utf-8 -*- +# +# instack-undercloud documentation build configuration file, created by +# sphinx-quickstart on Wed Feb 25 10:56:57 2015. +# +# This file is execfile()d with the current directory set to its containing dir. +# +# 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 +import sphinx_rtd_theme + +# 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.autodoc', + 'sphinx.ext.intersphinx', + 'oslosphinx' +] + + +# 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'Instack Undercloud' +copyright = u'2015, OpenStack Foundation' +bug_tracker = u'Launchpad' +bug_tracker_url = u'https://launchpad.net/tripleo' + +# 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 = '3.0.0' +# The full version, including alpha/beta/rc tags. +release = '3.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 = '' +# 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 = 'sphinx' + +# A list of ignored prefixes for module index sorting. +#modindex_common_prefix = [] + + +# -- Options for HTML output --------------------------------------------------- + +html_static_path = ['_custom'] +# html_style = 'custom.css' +templates_path = ['_templates'] + +# Output file base name for HTML help builder. +htmlhelp_basename = '%sdoc' % project + + +# -- Options for LaTeX output -------------------------------------------------- + +latex_elements = { +# The paper size ('letterpaper' or 'a4paper'). +#'papersize': 'letterpaper', + +# The font size ('10pt', '11pt' or '12pt'). +#'pointsize': '10pt', + +# Additional stuff for the LaTeX preamble. +#'preamble': '', +} + +rst_prolog = """ +.. |project| replace:: %s +.. |bug_tracker| replace:: %s +.. |bug_tracker_url| replace:: %s +""" % (project, bug_tracker, bug_tracker_url) diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 000000000..074a98279 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,3 @@ +Welcome to |project| documentation +==================================== + diff --git a/setup.cfg b/setup.cfg index 234d44156..7cd805907 100644 --- a/setup.cfg +++ b/setup.cfg @@ -45,3 +45,8 @@ data_files = [entry_points] oslo.config.opts = instack-undercloud = instack_undercloud.undercloud:list_opts + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source diff --git a/tox.ini b/tox.ini index 1fa5a48a0..3e93e128d 100644 --- a/tox.ini +++ b/tox.ini @@ -13,6 +13,9 @@ commands = python setup.py testr --slowest --testr-args='{posargs}' [testenv:venv] commands = {posargs} +[testenv:docs] +commands = python setup.py build_sphinx + [testenv:pep8] whitelist_externals = bash # We fail pretty horribly on bashate right now