From 359352e80bccbf32aecf022cf1bc0ca0df2753bd Mon Sep 17 00:00:00 2001 From: Matthew Treinish Date: Fri, 28 Aug 2015 19:03:41 -0400 Subject: [PATCH] Add docs building support to grenade This commit adds basic docs building support to grenade. Previously we just had rst files in the root of the repo and relied on github or something else to render them. After this commit we'll support sphinx built docs. The next step after this is to add a docs publishing job to infra so we'll have hosted grenade documentation like other projects. Change-Id: I505c1d5e250d103b6e0f9da008f44d3ce28df94f --- .gitignore | 6 + PLUGINS.rst | 5 +- README.rst | 40 +++---- doc/source/conf.py | 263 +++++++++++++++++++++++++++++++++++++++++ doc/source/hacking.rst | 1 + doc/source/index.rst | 27 +++++ doc/source/plugins.rst | 1 + doc/source/readme.rst | 1 + setup.cfg | 22 ++++ setup.py | 22 ++++ tools/build_docs.sh | 100 ++++++++++++++++ tox.ini | 19 +++ 12 files changed, 484 insertions(+), 23 deletions(-) create mode 100644 doc/source/conf.py create mode 100644 doc/source/hacking.rst create mode 100644 doc/source/index.rst create mode 100644 doc/source/plugins.rst create mode 100644 doc/source/readme.rst create mode 100644 setup.cfg create mode 100755 setup.py create mode 100755 tools/build_docs.sh diff --git a/.gitignore b/.gitignore index 3628bdd2..c57f09af 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,9 @@ devstack.localrc localrc *.swp +doc/files +doc/build +shocco +.tox +AUTHORS +ChangeLog diff --git a/PLUGINS.rst b/PLUGINS.rst index 37fcc1e0..90f4e5f0 100644 --- a/PLUGINS.rst +++ b/PLUGINS.rst @@ -9,8 +9,7 @@ number of services. Proposed new basic flow: - setup_grenade - - all the magic setup involved around err traps and filehandle - redirects + - all the magic setup involved around err traps and filehandle redirects - setup devstack trees - setup_base - run stack.sh to build the correct base environment @@ -65,7 +64,7 @@ service is running in an upgrade environment. The script should return zero on success for actions, and nonzero on failure. Calling Interface ---------- +----------------- The following is the supported calling interface diff --git a/README.rst b/README.rst index 0df2ff49..ca84be93 100644 --- a/README.rst +++ b/README.rst @@ -90,7 +90,7 @@ high level version of what that does. - perform some sanity checking (currently tempest smoke) to ensure this is right - allow projects to create resources that should survive upgrade - - see projects/*/resources.sh + - see projects/\*/resources.sh - shut down all services - verify resources are still working during shutdown - upgrade and restart all services @@ -113,26 +113,26 @@ Directory Structure =================== Grenade creates a set of directories for both the base and target -OpenStack installation sources and DevStack. +OpenStack installation sources and DevStack:: -$STACK_ROOT - |- logs # Grenade logs - |- save # Grenade state logs - |- - | |- data # base data - | |- logs # base DevStack logs - | |- devstack - | |- images # cache of downloaded images - | |- cinder - | |- ... - | |- swift - |- - | |- data # target data - | |- logs # target DevStack logs - | |- devstack - | |- cinder - | |- ... - | |- swift + $STACK_ROOT + |- logs # Grenade logs + |- save # Grenade state logs + |- + | |- data # base data + | |- logs # base DevStack logs + | |- devstack + | |- images # cache of downloaded images + | |- cinder + | |- ... + | |- swift + |- + | |- data # target data + | |- logs # target DevStack logs + | |- devstack + | |- cinder + | |- ... + | |- swift Dependencies ============ diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 00000000..1a2c46e0 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,263 @@ +# -*- coding: utf-8 -*- +# +# Tempest documentation build configuration file, created by +# sphinx-quickstart on Tue May 21 17:43:32 2013. +# +# 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 +import 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 = [ 'oslosphinx', 'sphinxcontrib.blockdiag', 'sphinxcontrib.nwdiag' ] + +todo_include_todos = True + +# 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'Grenade' +copyright = u'2015, OpenStack Foundation' + +# 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 = ['_build'] + +# 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 = False + +# 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 = ['Grenade-doc.'] + +# -- Options for man page output ---------------------------------------------- +man_pages = [] + +# -- Options for HTML output --------------------------------------------------- + +# The theme to use for HTML and HTML Help pages. See the documentation for +# a list of builtin themes. +html_theme = 'nature' + +# Theme options are theme-specific and customize the look and feel of a theme +# further. For a list of options available for each theme, see the +# documentation. +#html_theme_options = {} + +# Add any paths that contain custom themes here, relative to this directory. +#html_theme_path = [] + +# The name for this set of Sphinx documents. If None, it defaults to +# " v documentation". +#html_title = None + +# A shorter title for the navigation bar. Default is the same as html_title. +#html_short_title = None + +# The name of an image file (relative to this directory) to place at the top +# of the sidebar. +#html_logo = None + +# The name of an image file (within the static path) to use as favicon of the +# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32 +# pixels large. +#html_favicon = None + +# If not '', a 'Last updated on:' timestamp is inserted at every page bottom, +# using the given strftime format. +git_cmd = "git log --pretty=format:'%ad, commit %h' --date=local -n1" +html_last_updated_fmt = os.popen(git_cmd).read() + +# If true, SmartyPants will be used to convert quotes and dashes to +# typographically correct entities. +#html_use_smartypants = True + +# Custom sidebar templates, maps document names to template names. +#html_sidebars = {} + +# Additional templates that should be rendered to pages, maps page names to +# template names. +#html_additional_pages = {} + +# If false, no module index is generated. +html_domain_indices = False + +# If false, no index is generated. +html_use_index = False + +# If true, the index is split into individual pages for each letter. +#html_split_index = False + +# If true, links to the reST sources are added to the pages. +#html_show_sourcelink = True + +# If true, "Created using Sphinx" is shown in the HTML footer. Default is True. +#html_show_sphinx = True + +# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True. +#html_show_copyright = True + +# If true, an OpenSearch description file will be output, and all pages will +# contain a tag referring to it. The value of this option must be the +# base URL from which the finished HTML is served. +#html_use_opensearch = '' + +# This is the file name suffix for HTML files (e.g. ".xhtml"). +#html_file_suffix = None + +# Output file base name for HTML help builder. +htmlhelp_basename = 'Grenade-doc' + + +# -- 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': '', +} + +# Grouping the document tree into LaTeX files. List of tuples +# (source start file, target name, title, author, documentclass [howto/manual]). +latex_documents = [ + ('index', 'Grenade-doc.tex', u'Grenade Docs', + u'OpenStack Grenade Team', 'manual'), +] + +# The name of an image file (relative to this directory) to place at the top of +# the title page. +#latex_logo = None + +# For "manual" documents, if this is true, then toplevel headings are parts, +# not chapters. +#latex_use_parts = False + +# If true, show page references after internal links. +#latex_show_pagerefs = False + +# If true, show URL addresses after external links. +#latex_show_urls = False + +# Documents to append as an appendix to all manuals. +#latex_appendices = [] + +# If false, no module index is generated. +#latex_domain_indices = True + +# -- Options for Texinfo output ------------------------------------------------ + +# Grouping the document tree into Texinfo files. List of tuples +# (source start file, target name, title, author, +# dir menu entry, description, category) +texinfo_documents = [ + ('index', 'Grenade-doc', u'Grenade Docs', + u'OpenStack Grenade Team', 'Grenade-doc', 'Grenade documentation', + 'Miscellaneous'), +] + +# Documents to append as an appendix to all manuals. +#texinfo_appendices = [] + +# If false, no module index is generated. +#texinfo_domain_indices = True + +# How to display URL addresses: 'footnote', 'no', or 'inline'. +#texinfo_show_urls = 'footnote' + + +# -- Options for Epub output --------------------------------------------------- + +# Bibliographic Dublin Core info. +epub_title = u'Grenade Documentation' +epub_author = u'OpenStack Grenade Team' +epub_publisher = u'OpenStack Grenade Team' +epub_copyright = u'2014, OpenStack Grenade Team' + +# The language of the text. It defaults to the language option +# or en if the language is not set. +#epub_language = '' + +# The scheme of the identifier. Typical schemes are ISBN or URL. +#epub_scheme = '' + +# The unique identifier of the text. This can be a ISBN number +# or the project homepage. +#epub_identifier = '' + +# A unique identification for the text. +#epub_uid = '' + +# A tuple containing the cover image and cover page html template filenames. +#epub_cover = () + +# HTML files that should be inserted before the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_pre_files = [] + +# HTML files shat should be inserted after the pages created by sphinx. +# The format is a list of tuples containing the path and title. +#epub_post_files = [] + +# A list of files that should not be packed into the epub file. +#epub_exclude_files = [] + +# The depth of the table of contents in toc.ncx. +#epub_tocdepth = 3 + +# Allow duplicate toc entries. +#epub_tocdup = True diff --git a/doc/source/hacking.rst b/doc/source/hacking.rst new file mode 100644 index 00000000..a2bcf4fd --- /dev/null +++ b/doc/source/hacking.rst @@ -0,0 +1 @@ +.. include:: ../../HACKING.rst diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 00000000..de47c1c8 --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,27 @@ +Grenade - an OpenStack Community Upgrade Production +=================================================== + +.. toctree:: + :glob: + :maxdepth: 1 + + readme + plugins + hacking + +Code +==== + +*A look at the bits that make it all go* + +Scripts +------- + +* `grenade.sh `__ - The main script +* `functions `__ - Grenade specific functions +* `run_resources.sh `__ +* `inc/bootstrap `__ +* `inc/plugin `__ +* `inc/upgrade `__ +* `clean.sh `__ +* `cache_git.sh `__ diff --git a/doc/source/plugins.rst b/doc/source/plugins.rst new file mode 100644 index 00000000..92439d95 --- /dev/null +++ b/doc/source/plugins.rst @@ -0,0 +1 @@ +.. include:: ../../PLUGINS.rst diff --git a/doc/source/readme.rst b/doc/source/readme.rst new file mode 100644 index 00000000..a6210d3d --- /dev/null +++ b/doc/source/readme.rst @@ -0,0 +1 @@ +.. include:: ../../README.rst diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..b7bc059d --- /dev/null +++ b/setup.cfg @@ -0,0 +1,22 @@ +[metadata] +name = Grenade +summary = OpenStack Grenade +description-file = + README.rst +author = OpenStack +author-email = openstack-dev@lists.openstack.org +classifier = + Intended Audience :: Developers + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + +[build_sphinx] +all_files = 1 +build-dir = doc/build +source-dir = doc/source + +[pbr] +warnerrors = True + +[wheel] +universal = 1 diff --git a/setup.py b/setup.py new file mode 100755 index 00000000..70c2b3f3 --- /dev/null +++ b/setup.py @@ -0,0 +1,22 @@ +#!/usr/bin/env python +# Copyright (c) 2013 Hewlett-Packard Development Company, L.P. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or +# implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +# THIS FILE IS MANAGED BY THE GLOBAL REQUIREMENTS REPO - DO NOT EDIT +import setuptools + +setuptools.setup( + setup_requires=['pbr'], + pbr=True) diff --git a/tools/build_docs.sh b/tools/build_docs.sh new file mode 100755 index 00000000..fa843432 --- /dev/null +++ b/tools/build_docs.sh @@ -0,0 +1,100 @@ +#!/usr/bin/env bash + +# **build_docs.sh** - Build the docs for DevStack +# +# - Install shocco if not found on ``PATH`` and ``INSTALL_SHOCCO`` is set +# - Clone ``MASTER_REPO`` branch ``MASTER_BRANCH`` +# - Re-creates ``doc/build/html`` directory from existing repo + new generated script docs + +# Usage: +## build_docs.sh [-o ] +## -o Write the static HTML output to +## (Note that will be deleted and re-created to ensure it is clean) + +# Defaults +# -------- + +HTML_BUILD=doc/build/html + +# Keep track of the DevStack directory +TOP_DIR=$(cd $(dirname "$0")/.. && pwd) + +# Uses this shocco branch: https://github.com/dtroyer/shocco/tree/rst_support +SHOCCO=${SHOCCO:-shocco} +if ! which shocco; then + if [[ ! -x $TOP_DIR/shocco/shocco ]]; then + if [[ -z "$INSTALL_SHOCCO" ]]; then + echo "shocco not found in \$PATH, please set environment variable SHOCCO" + exit 1 + fi + echo "Installing local copy of shocco" + if ! which pygmentize; then + sudo pip install Pygments + fi + if ! which rst2html.py; then + sudo pip install docutils + fi + git clone -b rst_support https://github.com/dtroyer/shocco shocco + cd shocco + ./configure + make || exit + cd .. + fi + SHOCCO=$TOP_DIR/shocco/shocco +fi + +# Process command-line args +while getopts o: c; do + case $c in + o) HTML_BUILD=$OPTARG + ;; + esac +done +shift `expr $OPTIND - 1` + + +# Processing +# ---------- + +# Ensure build dir exists +mkdir -p $HTML_BUILD + +# Get fully qualified dirs +FQ_HTML_BUILD=$(cd $HTML_BUILD && pwd) + +# Insert automated bits +GLOG=$(mktemp gitlogXXXX) +echo "
    " >$GLOG +git log \ + --pretty=format:'
  • %s - Commit %h %cd
    • ' \ + --date=short \ + --since '6 months ago' | grep -v Merge >>$GLOG +echo "
" >>$GLOG +sed -i~ -e $"/^.*%GIT_LOG%.*$/r $GLOG" -e $"/^.*%GIT_LOG%.*$/s/^.*%GIT_LOG%.*$//" $FQ_HTML_BUILD/changes.html +rm -f $GLOG + +# Build list of scripts to process +FILES="" +for f in $(find . \( -name .git -o -name .tox \) -prune -o \( -type f -name \*.sh -not -path \*shocco/\* -print \)); do + echo $f + FILES+="$f " + mkdir -p $FQ_HTML_BUILD/`dirname $f`; + $SHOCCO $f > $FQ_HTML_BUILD/$f.html +done +for f in $(find functions functions-common inc lib pkg samples -type f -name \*); do + echo $f + FILES+="$f " + mkdir -p $FQ_HTML_BUILD/`dirname $f`; + $SHOCCO $f > $FQ_HTML_BUILD/$f.html +done +echo "$FILES" >doc/files + +# Clean up or report the temp workspace +if [[ -n REPO && -n $PUSH_REPO ]]; then + echo rm -rf $TMP_ROOT +else + if [[ -z "$TMP_ROOT" ]]; then + TMP_ROOT="$(pwd)" + fi + echo "Built docs in $HTML_BUILD" +fi diff --git a/tox.ini b/tox.ini index 2a67c031..053f4e90 100644 --- a/tox.ini +++ b/tox.ini @@ -11,3 +11,22 @@ deps = -r{toxinidir}/test-requirements.txt [testenv:bashate] commands = bash -c "ls *.sh prep-* stop-* upgrade-* from-*/upgrade-* functions | xargs bashate -v {posargs}" + +[testenv:docs] +deps = + Pygments + docutils + sphinx>=1.1.2,<1.2 + pbr>=0.6,!=0.7,<1.0 + oslosphinx + nwdiag + blockdiag + sphinxcontrib-blockdiag + sphinxcontrib-nwdiag +whitelist_externals = bash +setenv = + TOP_DIR={toxinidir} + INSTALL_SHOCCO=true +commands = + python setup.py build_sphinx + bash tools/build_docs.sh