diff --git a/doc/source/conf.py b/doc/source/conf.py index c9702263..482e3f15 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -37,6 +37,9 @@ sys.path.insert(0, os.path.abspath('../../muranoagent')) #extensions = ['sphinx.ext.autodoc', 'sphinx.ext.doctest', 'sphinx.ext.todo', 'sphinx.ext.coverage', # 'sphinx.ext.pngmath', 'sphinx.ext.viewcode', 'sphinxcontrib.httpdomain'] +extensions = [ + 'openstackdocstheme', +] # Add any paths that contain templates here, relative to this directory. # templates_path = ['_templates'] @@ -112,6 +115,15 @@ pygments_style = 'sphinx' # Add any paths that contain custom themes here, relative to this directory. #html_theme_path = [] +html_theme = 'openstackdocs' +# openstackdocstheme options +repository_name = 'openstack/murano-agent' +bug_project = 'murano' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # The name for this set of Sphinx documents. If None, it defaults to # " v documentation". html_title = 'Murano Agent' @@ -136,9 +148,6 @@ html_title = 'Murano Agent' # If not '', a 'Last updated on:' timestamp is inserted at every page bottom, # using the given strftime format. #html_last_updated_fmt = '%b %d, %Y' -git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local", - "-n1"] -html_last_updated_fmt = subprocess.check_output(git_cmd) # If true, SmartyPants will be used to convert quotes and dashes to # typographically correct entities. diff --git a/releasenotes/source/conf.py b/releasenotes/source/conf.py index 44b16c75..2932df82 100644 --- a/releasenotes/source/conf.py +++ b/releasenotes/source/conf.py @@ -38,7 +38,7 @@ # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. extensions = [ - 'oslosphinx', + 'openstackdocstheme', 'reno.sphinxext', ] @@ -112,7 +112,15 @@ pygments_style = 'sphinx' # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'default' +html_theme = 'openstackdocs' + +# openstackdocstheme options +repository_name = 'openstack/murano-agent' +bug_project = 'murano' +bug_tag = '' + +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' # 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 diff --git a/setup.cfg b/setup.cfg index 14abfd3d..95331be6 100644 --- a/setup.cfg +++ b/setup.cfg @@ -39,6 +39,7 @@ console_scripts = all_files = 1 build-dir = doc/build source-dir = doc/source +warning-is-error = 1 [egg_info] tag_build = diff --git a/test-requirements.txt b/test-requirements.txt index 6a0fc4c2..ed872d92 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -10,6 +10,6 @@ testrepository>=0.0.18 # Apache-2.0/BSD oslotest>=1.10.0 # Apache-2.0 # doc build requirements -oslosphinx>=4.7.0 # Apache-2.0 +openstackdocstheme>=1.11.0 # Apache-2.0 sphinx>=1.6.2 # BSD reno!=2.3.1,>=1.8.0 # Apache-2.0