openstack
/
validations-libs
Code Issues Proposed changes

Man pages compatibility 

Created section describing structure of our man pages.
Removed superflous title in the CLI documentation to improve
man page readability.

Signed-off-by: Jiri Podivin <jpodivin@redhat.com>
Change-Id: Ib302190408c4c684b96cc30e9cf2cb6b1c00c086
(cherry picked from commit 9ed3888273)
This commit is contained in:
Jiri Podivin 2022-05-26 15:37:08 +02:00
parent 59e55fb25c
commit ca1f4ebf93
2 changed files with 14 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
doc/source/cli.rst
View File

@ -4,12 +4,6 @@
Validations Framework Command Line Interface (CLI)
==================================================
The following documentation is generated using the `the cliff Sphinx extension
<sphinxext>`.
Output
------
Global Options
~~~~~~~~~~~~~~

14
doc/source/conf.py
View File

@ -35,6 +35,20 @@ extensions = [
'openstackdocstheme',
]
# Settings MAN pages targets
man_pages = [(
'cli',
'vf',
'validate environments',
'Openstack',
'1'),
(
'reference/index',
'validations-libs',
'API description',
'Openstack',
'3')]
# sphinxcontrib.apidoc options
apidoc_module_dir = '../../validations_libs'
apidoc_output_dir = 'reference/api'