From c7977097366870bd5afbdb27a82ef1e3eee1e280 Mon Sep 17 00:00:00 2001 From: Kien Nguyen Date: Thu, 14 Dec 2017 11:36:38 +0700 Subject: [PATCH] Fix Zun-tempest-plugin's documentation Change-Id: Iebb6f1604a0b02919ad7419f42b4ecab47486021 --- README.rst | 4 ++-- doc/source/conf.py | 7 +++++-- doc/source/index.rst | 2 +- test-requirements.txt | 1 + tox.ini | 4 +++- 5 files changed, 12 insertions(+), 6 deletions(-) diff --git a/README.rst b/README.rst index b945fef..70fa61e 100644 --- a/README.rst +++ b/README.rst @@ -13,10 +13,10 @@ This directory contains Tempest tests to cover the Zun project, as well as a plugin to automatically load these tests into tempest. See the Tempest plugin docs for information on using it: -https://docs.openstack.org/developer/tempest/plugin.html#using-plugins +https://docs.openstack.org/tempest/latest/#using-plugins * Free software: Apache license -* Documentation: https://docs.openstack.org/developer/zun-tempest-plugin +* Documentation: https://docs.openstack.org/zun-tempest-plugin/latest * Source: https://git.openstack.org/cgit/openstack/zun-tempest-plugin * Bugs: https://bugs.launchpad.net/zun diff --git a/doc/source/conf.py b/doc/source/conf.py index ae8d4bf..f78cd00 100755 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -37,11 +37,11 @@ source_suffix = '.rst' master_doc = 'index' # General information about the project. -project = u'zun_tempest_plugin' +project = u'zun-tempest-plugin' copyright = u'2017, OpenStack Developers' # openstackdocstheme options -repository_name = 'openstack/zun_tempest_plugin' +repository_name = 'openstack/zun-tempest-plugin' bug_project = 'zun' bug_tag = '' @@ -67,6 +67,9 @@ html_theme = 'openstackdocs' # Output file base name for HTML help builder. htmlhelp_basename = '%sdoc' % project +# Must set this variable to include year, month, day, hours, and minutes. +html_last_updated_fmt = '%Y-%m-%d %H:%M' + # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, author, documentclass # [howto/manual]). diff --git a/doc/source/index.rst b/doc/source/index.rst index ea5cf47..e26ae07 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -4,7 +4,7 @@ contain the root `toctree` directive. ================================================== -Welcome to the documentation of zun_tempest_plugin +Welcome to the documentation of Zun tempest plugin ================================================== Contents: diff --git a/test-requirements.txt b/test-requirements.txt index e363ddc..af6a092 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -8,3 +8,4 @@ sphinx>=1.6.2 # BSD openstackdocstheme>=1.11.0 # Apache-2.0 # releasenotes reno>=1.8.0 # Apache-2.0 +doc8>=0.6.0 # Apache-2.0 diff --git a/tox.ini b/tox.ini index c888992..ab82b8a 100644 --- a/tox.ini +++ b/tox.ini @@ -22,7 +22,9 @@ commands = {posargs} commands = python setup.py test --coverage --testr-args='{posargs}' [testenv:docs] -commands = python setup.py build_sphinx +commands = + doc8 -e .rst doc/source/ CONTRIBUTING.rst HACKING.rst README.rst + python setup.py build_sphinx [testenv:releasenotes] commands =