From 77998d4316436b3cf97c6d9f7c8b71f8f0701a64 Mon Sep 17 00:00:00 2001 From: Radoslaw Smigielski Date: Mon, 7 Jan 2019 07:06:41 +0100 Subject: [PATCH] Fix Sphinx warnings on auto generated workbooks docs Workbooks/workflow HTML docs are generated from descriptions and input params taken from workbooks .yaml files by: doc/source/_exts/workbooks.py Problems are: - multiline descriptions are not formatted correctly and generates Sphinx warnings - missing line before section "Workflow inputs:" generates Sphinx warnings Change-Id: Ibb40b025ccb9470096da79deb5b5002444474071 Partial-Bug: 1810707 --- doc/source/_exts/workbooks.py | 12 ++++++++---- 1 file changed, 8 insertions(+), 4 deletions(-) diff --git a/doc/source/_exts/workbooks.py b/doc/source/_exts/workbooks.py index 7db5438c5..0725993d8 100644 --- a/doc/source/_exts/workbooks.py +++ b/doc/source/_exts/workbooks.py @@ -54,12 +54,16 @@ def _workbook_to_rst(name, workbook): yield '' if 'description' in workflow: - yield ' {}'.format(workflow['description']) - yield '' + if len(workflow['description'].split("\n"))>2: + for _line in workflow['description'].split("\n"): + _new_line = ' ' + _line + yield _new_line + else: + yield ' {}'.format(workflow['description']) + yield '' if 'input' in workflow: - yield ' Workflow inputs:' - yield '' + yield "\n Workflow inputs:\n" for input_param in workflow['input']: try: yield ' :input {}: Default: {}'.format(