diff options
author | Hervé Beraud <hberaud@redhat.com> | 2020-07-21 13:35:45 +0200 |
---|---|---|
committer | Hervé Beraud <hberaud@redhat.com> | 2020-09-03 14:20:33 +0200 |
commit | b1122e81ab8a46f4d6566bcad7e1a4ceabcb4f3e (patch) | |
tree | b65cf3d61758548c94e50385edca5a6418fbec4c /doc | |
parent | ed1659a5e30967edecc98ff085578e7577151aef (diff) | |
download | oslo-rootwrap-b1122e81ab8a46f4d6566bcad7e1a4ceabcb4f3e.tar.gz |
Adding pre-commit
Introduced changes:
- pre-commit config and rules
- Add pre-commit to pep8 gate, Flake8 is covered in the pre-commit hooks.
- Applying fixes for pre-commit compliance in all code.
Also commit hash will be used instead of version tags in pre-commit to
prevend arbitrary code from running in developer's machines.
pre-commit will be used to:
- trailing whitespace;
- Replaces or checks mixed line ending (mixed-line-ending);
- Forbid files which have a UTF-8 byte-order marker (check-byte-order-marker);
- Checks that non-binary executables have a proper
shebang (check-executables-have-shebangs);
- Check for files that contain merge conflict strings (check-merge-conflict);
- Check for debugger imports and py37+ breakpoint()
calls in python source (debug-statements);
- Attempts to load all yaml files to verify syntax (check-yaml);
- Run flake8 checks (flake8) (local)
For further details about tests please refer to:
https://github.com/pre-commit/pre-commit-hooks
Change-Id: I04e73b8a70d32fec3e6131526e0bed0be8599c28
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
Diffstat (limited to 'doc')
-rw-r--r--[-rwxr-xr-x] | doc/source/conf.py | 6 |
1 files changed, 2 insertions, 4 deletions
diff --git a/doc/source/conf.py b/doc/source/conf.py index e32b4b0..1a530ae 100755..100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -1,4 +1,6 @@ # -*- coding: utf-8 -*- +# Copyright (C) 2020 Red Hat, Inc. +# # 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 @@ -22,7 +24,6 @@ sys.path.insert(0, os.path.abspath('../..')) # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom ones. extensions = [ 'sphinx.ext.autodoc', - #'sphinx.ext.intersphinx', 'openstackdocstheme', ] @@ -76,6 +77,3 @@ latex_documents = [ u'%s Documentation' % project, u'OpenStack Foundation', 'manual'), ] - -# Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} |