diff --git a/doc/specs/README.rst b/doc/specs/README.rst index b53d3e8f..850c145c 100644 --- a/doc/specs/README.rst +++ b/doc/specs/README.rst @@ -10,5 +10,6 @@ This directory contains 2 subdirectories: - in-progress - These specs are approved, but they are not implemented yet - implemented - Implemented specs archive -If you are looking for full rally road map overview go `here `_. +If you are looking for full rally road map overview go +`here `_. diff --git a/doc/specs/template.rst b/doc/specs/template.rst index a6a03167..02e17c08 100644 --- a/doc/specs/template.rst +++ b/doc/specs/template.rst @@ -7,15 +7,15 @@ .. This template should be in ReSTructured text. The filename in the git repository should match the launchpad URL, for example a URL of - https://blueprints.launchpad.net/heat/+spec/awesome-thing should be named + https://blueprints.launchpad.net/rally/+spec/awesome-thing should be named awesome-thing.rst . Please do not delete any of the sections in this template. If you have nothing to say for a whole section, just write: None For help with syntax, see http://sphinx-doc.org/rest.html To test out your formatting, see http://www.tele3.cz/jbar/rest/rest.html -======================= - The title of your Spec -======================= +====================== +The title of your Spec +====================== Rally Road map: @@ -81,3 +81,8 @@ Dependencies - Does this feature require any new library dependencies or code otherwise not included in OpenStack? Or does it depend on a specific version of library? + +References +========== + +Links to some external resources. diff --git a/tests/unit/doc/test_specs.py b/tests/unit/doc/test_specs.py index 2a68f5cc..496d0044 100644 --- a/tests/unit/doc/test_specs.py +++ b/tests/unit/doc/test_specs.py @@ -16,15 +16,16 @@ import re import docutils.core +import rally from tests.unit import test class TitlesTestCase(test.TestCase): + OPTIONAL_SECTIONS = ["References"] + specs_path = os.path.join( - os.path.dirname(__file__), - os.pardir, os.pardir, os.pardir, - "doc", "specs") + os.path.dirname(rally.__file__), os.pardir, "doc", "specs") def _get_title(self, section_tree): section = {"subtitles": []} @@ -46,7 +47,9 @@ class TitlesTestCase(test.TestCase): return titles def _check_titles(self, filename, expect, actual): - missing_sections = [x for x in expect.keys() if x not in actual.keys()] + missing_sections = [ + x for x in expect.keys() + if x not in actual.keys() and x not in self.OPTIONAL_SECTIONS] extra_sections = [x for x in actual.keys() if x not in expect.keys()] msgs = []