openstack/nova
Code Issues Proposed changes

docs: Resolve issue with deprecated extra specs

Browse Source 
The warning directive should look like so:

  .. warning::

      Some text here.

However, we weren't indenting the body correctly, meaning the directive
appeared to have no content. Resolve this.

Change-Id: Ib93cbd7c5ba64e678393554ba77f568efdb2608a
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane 2020-05-08 10:15:26 +01:00
parent 487c4fa920
commit 8a2ed8a78e
1 changed files with 4 additions and 5 deletions

7
doc/ext/extra_specs.py

@ -81,11 +81,11 @@ class ExtraSpecDirective(sphinx_directives.ObjectDescription):
cached_options[sig] = self.env.docname cached_options[sig] = self.env.docname
def _indent(text): def _indent(text, count=1):
if not text: if not text:
return text return text
padding = ' ' * 4 padding = ' ' * (4 * count)
return padding + text return padding + text
@ -133,9 +133,8 @@ def _format_validator_help(
if validator.deprecated: if validator.deprecated:
yield _indent('.. warning::') yield _indent('.. warning::')
yield _indent( yield _indent(
'This extra spec has been deprecated and should not be used.' 'This extra spec has been deprecated and should not be used.', 2
) )
yield '' yield ''