diff --git a/deploy-guide/source/conf.py b/deploy-guide/source/conf.py index 91083fb..f492ce2 100644 --- a/deploy-guide/source/conf.py +++ b/deploy-guide/source/conf.py @@ -22,8 +22,6 @@ import os -import openstackdocstheme - # 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. @@ -38,7 +36,7 @@ import openstackdocstheme # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. # TODO(ajaeger): enable PDF building, for example add 'rst2pdf.pdfbuilder' -# extensions = +extensions = ['openstackdocstheme'] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -53,28 +51,21 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'OpenStack Charms Deployment Guide' -bug_tag = u'deployment-guide' copyright = u'2016, OpenStack contributors' +# Settings for openstackdocstheme +repository_name = 'openstack/charm-deployment-guide' +bug_project = 'charm-deployment-guide' +bug_tag = u'deployment-guide' + # 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.1' +version = '' # The full version, including alpha/beta/rc tags. -release = '0.1' - -# A few variables have to be set for the log-a-bug feature. -# gitsha: The SHA checksum of the bug description. Automatically extracted -# from git log. -# bug_tag: Tag for categorizing the bug. Must be set manually. -# These variables are passed to the logabug code via html_context. -git_cmd = "/usr/bin/git log | head -n1 | cut -f2 -d' '" -gitsha = os.popen(git_cmd).read().strip('\n') -html_context = {"gitsha": gitsha, "bug_tag": bug_tag, - "bug_project": "charm-deployment-guide"} +release = '' # The language for content autogenerated by Sphinx. Refer to documentation # for a list of supported languages. @@ -127,7 +118,7 @@ html_theme = 'openstackdocs' # html_theme_options = {} # Add any paths that contain custom themes here, relative to this directory. -html_theme_path = [openstackdocstheme.get_html_theme_path()] +# html_theme_path = [openstackdocstheme.get_html_theme_path()] # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". @@ -160,7 +151,7 @@ html_theme_path = [openstackdocstheme.get_html_theme_path()] # So that we can enable "log-a-bug" links from each output HTML page, this # variable must be set to a format that includes year, month, day, hours and # minutes. -html_last_updated_fmt = '%Y-%m-%d %H:%M' +# html_last_updated_fmt = '%Y-%m-%d %H:%M' # If true, SmartyPants will be used to convert quotes and dashes to @@ -201,24 +192,13 @@ html_show_sourcelink = False # html_file_suffix = None # Output file base name for HTML help builder. -htmlhelp_basename = 'install-guide' +htmlhelp_basename = 'deploy-guide' # If true, publish source files html_copy_source = False # -- 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, or own class]). diff --git a/requirements.txt b/requirements.txt index 4c02c23..a9c23bb 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,3 +1,9 @@ -sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3 # BSD -pbr>=1.6 # Apache-2.0 -openstackdocstheme>=1.5.0,<1.18.0 # Apache-2.0 +# The order of packages is significant, because pip processes them in the order +# of appearance. Changing the order has an impact on the overall integration +# process, which may cause wedges in the gate later. + +pbr!=2.1.0,>=2.0.0 # Apache-2.0 + +sphinx>=1.8.0,<2.0.0;python_version=='2.7' # BSD +sphinx>=1.8.0,!=2.1.0;python_version>='3.4' # BSD +openstackdocstheme>=1.30.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index 47c2f28..0ab5683 100644 --- a/tox.ini +++ b/tox.ini @@ -4,14 +4,11 @@ envlist = deploy-guide skipsdist = True [testenv] -basepython = python2.7 +basepython = python3 usedevelop = True -setenv = VIRTUAL_ENV={envdir} -install_command = pip install -U {opts} {packages} deps = -r{toxinidir}/requirements.txt [testenv:venv] -basepython = python3 commands = {posargs} [testenv:deploy-guide]