diff --git a/.gitignore b/.gitignore index 33defe43..b67a7628 100644 --- a/.gitignore +++ b/.gitignore @@ -1 +1,8 @@ .tox/ + +# Sphinx +doc/build + +# pbr generates these +AUTHORS +ChangeLog diff --git a/doc/source/conf.py b/doc/source/conf.py new file mode 100644 index 00000000..e5938a17 --- /dev/null +++ b/doc/source/conf.py @@ -0,0 +1,205 @@ +# -*- 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 = ['sphinx.ext.autodoc', + 'sphinx.ext.intersphinx', + 'sphinx.ext.todo', + 'sphinx.ext.viewcode', + 'oslosphinx' + ] + +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'defcore' +copyright = u'OpenStack Contributors' + +# 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 = True + +# 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 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 = 'defcore' + + +# -- 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', 'defcore.tex', u'OpenStack DefCore Documentation', + u'OpenStack Foundation', '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 diff --git a/images/500px-Core_flow.png b/doc/source/images/500px-Core_flow.png similarity index 100% rename from images/500px-Core_flow.png rename to doc/source/images/500px-Core_flow.png diff --git a/images/DefCore_Platform_and_Programs_v14.jpg b/doc/source/images/DefCore_Platform_and_Programs_v14.jpg similarity index 100% rename from images/DefCore_Platform_and_Programs_v14.jpg rename to doc/source/images/DefCore_Platform_and_Programs_v14.jpg diff --git a/images/Defcore_capabilities_criteria.png b/doc/source/images/Defcore_capabilities_criteria.png similarity index 100% rename from images/Defcore_capabilities_criteria.png rename to doc/source/images/Defcore_capabilities_criteria.png diff --git a/images/Defcore_designated_sections.png b/doc/source/images/Defcore_designated_sections.png similarity index 100% rename from images/Defcore_designated_sections.png rename to doc/source/images/Defcore_designated_sections.png diff --git a/doc/source/index.rst b/doc/source/index.rst new file mode 100644 index 00000000..64c3e31f --- /dev/null +++ b/doc/source/index.rst @@ -0,0 +1,23 @@ +.. OpenStack Defcore documentation master file + +Contents: + +===================== +Process Documentation +===================== + +.. toctree:: + :glob: + :maxdepth: 1 + + process/* + +===================== +Schema Documentation +===================== + +.. toctree:: + :glob: + :maxdepth: 1 + + schema/* diff --git a/process/2015A.rst b/doc/source/process/2015A.rst similarity index 100% rename from process/2015A.rst rename to doc/source/process/2015A.rst diff --git a/process/CoreCriteria.rst b/doc/source/process/CoreCriteria.rst similarity index 100% rename from process/CoreCriteria.rst rename to doc/source/process/CoreCriteria.rst diff --git a/process/CoreDefinition.rst b/doc/source/process/CoreDefinition.rst similarity index 100% rename from process/CoreDefinition.rst rename to doc/source/process/CoreDefinition.rst diff --git a/process/DesignatedSections.rst b/doc/source/process/DesignatedSections.rst similarity index 100% rename from process/DesignatedSections.rst rename to doc/source/process/DesignatedSections.rst diff --git a/process/GovernanceProcess.rst b/doc/source/process/GovernanceProcess.rst similarity index 100% rename from process/GovernanceProcess.rst rename to doc/source/process/GovernanceProcess.rst diff --git a/process/Lexicon.rst b/doc/source/process/Lexicon.rst similarity index 100% rename from process/Lexicon.rst rename to doc/source/process/Lexicon.rst diff --git a/process/PlatformCap.rst b/doc/source/process/PlatformCap.rst similarity index 100% rename from process/PlatformCap.rst rename to doc/source/process/PlatformCap.rst diff --git a/process/ProcessCycles.rst b/doc/source/process/ProcessCycles.rst similarity index 100% rename from process/ProcessCycles.rst rename to doc/source/process/ProcessCycles.rst diff --git a/schema/1.2.rst b/doc/source/schema/1.2.rst similarity index 100% rename from schema/1.2.rst rename to doc/source/schema/1.2.rst diff --git a/schema/1.3.rst b/doc/source/schema/1.3.rst similarity index 99% rename from schema/1.3.rst rename to doc/source/schema/1.3.rst index c95e1c96..e3134d65 100644 --- a/schema/1.3.rst +++ b/doc/source/schema/1.3.rst @@ -2,10 +2,12 @@ JSON Schema v1.3 ==================== Changes from v1.2 + :added: reference :added: tests-repositories :added: required-since -:added: tests now have block including idempotent_id and (optional) flagged information +:added: tests now have block including idempotent_id and (optional) flagged + information :change: guidelines to point to required-since :change: tests from array to hash :change: add hash after test-name keys diff --git a/setup.cfg b/setup.cfg new file mode 100644 index 00000000..70f99ec3 --- /dev/null +++ b/setup.cfg @@ -0,0 +1,30 @@ +[metadata] +name = defcore +summary = OpenStack DefCore Process +description-file = + README.rst +author = OpenStack +author-email = defcore-committee@lists.openstack.org +home-page = https://wiki.openstack.org/wiki/Governance/DefCoreCommitee +classifier = + Environment :: OpenStack + Intended Audience :: Information Technology + Intended Audience :: System Administrators + License :: OSI Approved :: Apache Software License + Operating System :: POSIX :: Linux + Programming Language :: Python + Programming Language :: Python :: 2 + Programming Language :: Python :: 2.7 + Programming Language :: Python :: 3 + Programming Language :: Python :: 3.3 + +[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 100644 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/test-requirements.txt b/test-requirements.txt index 77e11877..d7def617 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -1,2 +1,4 @@ pygments doc8 +oslosphinx +sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 diff --git a/tox.ini b/tox.ini index 40ddadb3..4e9ea0b5 100644 --- a/tox.ini +++ b/tox.ini @@ -10,4 +10,8 @@ deps = -r{toxinidir}/test-requirements.txt [testenv:doc8] commands = - doc8 --ignore-path={envdir} --ignore-path=*.txt --ignore-path=**/*.txt + doc8 -e .rst doc/source + +[testenv:docs] +commands= + python setup.py build_sphinx