Fixups for docs naming conventions

- remove watermark since it doesn't work in Zuul

Change-Id: Ib1fe4e405060350daa89baac422c908af33f46c2
This commit is contained in:
Samuel Cassiba 2018-08-07 17:40:10 -07:00
parent 0a3f3942e2
commit 331e3abfd5
3 changed files with 8 additions and 44 deletions

View File

@ -17,10 +17,10 @@ import sys
import openstackdocstheme
# -- Chef OpenStack configuration --------------------------------------------
target_name = 'chef-openstack-docs'
target_name = 'openstack-chef'
description = 'Chef OpenStack uses Chef to deploy OpenStack environments.'
previous_series_name = 'pike'
current_series_name = 'queens'
previous_series_name = 'queens'
current_series_name = 'rocky'
# -- Project information -----------------------------------------------------
@ -29,34 +29,6 @@ category = 'Miscellaneous'
copyright = u'2014-2018, Chef OpenStack Contributors'
author = u'Chef OpenStack Contributors'
current_series = openstackdocstheme.ext._get_series_name()
if current_series == "latest":
watermark = "Pre-release"
latest_tag = "master"
branch = "master"
upgrade_warning = "Upgrading to master is not recommended. Master is under heavy development, and is not stable."
else:
watermark = series_names = current_series.capitalize()
latest_tag = os.popen('git describe --abbrev=0 --tags').read().strip('\n')
branch = "stable/{}".format(current_series)
upgrade_warning = "The upgrade is always under active development."
# Substitutions loader
rst_epilog = """
.. |current_release_git_branch_name| replace:: {current_release_git_branch_name}
.. |previous_release_formal_name| replace:: {previous_release_formal_name}
.. |current_release_formal_name| replace:: {current_release_formal_name}
.. |latest_tag| replace:: {latest_tag}
.. |upgrade_warning| replace:: {upgrade_warning}
""".format(
current_release_git_branch_name=branch,
previous_release_formal_name=previous_series_name.capitalize(),
current_release_formal_name=current_series_name.capitalize(),
latest_tag=latest_tag,
upgrade_warning=upgrade_warning,
)
# -- General configuration ---------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
@ -70,8 +42,7 @@ extensions = [
'openstackdocstheme',
'sphinx.ext.autodoc',
'sphinx.ext.extlinks',
'sphinx.ext.viewcode',
'sphinxmark'
'sphinx.ext.viewcode'
]
todo_include_docs = True
@ -207,11 +178,3 @@ pdf_documents = [
title, author)
]
# -- Options for sphinxmark -----------------------------------------------
sphinxmark_enable = True
sphinxmark_div = 'docs-body'
sphinxmark_image = 'text'
sphinxmark_text = watermark
sphinxmark_text_color = (128, 128, 128)
sphinxmark_text_size = 70

View File

@ -77,11 +77,11 @@ is usually best to checkout the latest tagged version.
# git branch -v
## Checkout the stable branch
# git checkout |current_release_git_branch_name|
# git checkout master
.. note::
The |current_release_formal_name| release is compatible with Ubuntu 16.04
(Xenial Xerus) and CentOS 7
The master release is compatible with Ubuntu 18.04
(Bionic Beaver) and CentOS 7
By default the cookbooks deploy all OpenStack services with sensible defaults
for the purpose of a gate check, development or testing system.

View File

@ -16,6 +16,7 @@ classifier =
all_files = 1
build-dir = doc/build
source-dir = doc/source
warning-is-error = 1
[pbr]
warnerrors = True