diff --git a/.gitignore b/.gitignore index 963e589..b1d88e0 100644 --- a/.gitignore +++ b/.gitignore @@ -17,6 +17,7 @@ develop-eggs .installed.cfg lib lib64 +doc/source/_errors_list.rst # Installer logs pip-log.txt diff --git a/doc/source/errors.rst b/doc/source/errors.rst new file mode 100644 index 0000000..1c3edb9 --- /dev/null +++ b/doc/source/errors.rst @@ -0,0 +1,4 @@ +============== +List of errors +============== +.. include:: _errors_list.rst diff --git a/doc/source/index.rst b/doc/source/index.rst index e95ad72..f71784d 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -13,6 +13,7 @@ Contents: readme installation + errors usage contributing diff --git a/tools/gen_errors.py b/tools/gen_errors.py new file mode 100644 index 0000000..4a1c514 --- /dev/null +++ b/tools/gen_errors.py @@ -0,0 +1,45 @@ +# Copyright 2016: Mirantis Inc. +# All Rights Reserved. +# +# Licensed under the Apache License, Version 2.0 (the "License"); you may +# not use this file except in compliance with the License. You may obtain +# a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, WITHOUT +# WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the +# License for the specific language governing permissions and limitations +# under the License. + +import jinja2 +import six + +from muranopkgcheck import error + +TEMPLATE = """ +============ ================================================================ + CODE DESCRITION +============ ================================================================ +{% for err in errors %}{{ err.code }} {{err.description}} +{% endfor %} +============ ================================================================ +""" + + +def main(): + from muranopkgcheck import validators + print('Validators:') + for v in validators.VALIDATORS: + print(v.__name__) + errors = sorted(six.itervalues(error.errors), + key=lambda item: item['code']) + t = jinja2.Template(TEMPLATE) + r = t.render(errors=errors) + print(r) + with open('doc/source/_errors_list.rst', 'w') as f: + f.write(r) + +if __name__ == '__main__': + main() diff --git a/tox.ini b/tox.ini index be635c8..11d8ad1 100644 --- a/tox.ini +++ b/tox.ini @@ -23,7 +23,9 @@ commands = {posargs} commands = {toxinidir}/tools/cover.sh {posargs} [testenv:docs] -commands = python setup.py build_sphinx +commands = + python tools/gen_errors.py + python setup.py build_sphinx [testenv:releasenotes] commands =