murano-pkg-check/doc/source
Andreas Jaeger ebb9fe8aa4 Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: Idae29b3be9edde2038711d537668514bb2c34946
2020-05-21 20:24:51 +02:00
..
conf.py Switch to newer openstackdocstheme and reno versions 2020-05-21 20:24:51 +02:00
contributing.rst Commit project structure 2016-08-22 16:46:38 +03:00
errors.rst Added docs autogeneration for error list 2016-09-13 16:37:16 +03:00
index.rst PDF documentation build 2019-09-17 22:52:43 -07:00
installation.rst Commit project structure 2016-08-22 16:46:38 +03:00
readme.rst PDF documentation build 2019-09-17 22:52:43 -07:00
usage.rst Commit project structure 2016-08-22 16:46:38 +03:00

About murano-pkg-check

Murano package validator tool

After checking out tool from repository easiest method to run tool is to run

tox -e venv -- murano-pkg-check -h

This command will display help for murano-pkg-validator

If you installed it from PYPI you can use: .. code-block:: console

murano-pkg-check -h

To run validator in directory apache-app just run: .. code-block:: console

murano-pkg-check apache-app

It will print all errors there are on package.

murano-pkg-check --discovery murano-apps

Will search for all packages under directory murano-apps. It will print all errors and warnings for all packages found.