diff options
author | Hervé Beraud <hberaud@redhat.com> | 2020-07-21 13:30:15 +0200 |
---|---|---|
committer | Hervé Beraud <hberaud@redhat.com> | 2020-09-08 14:01:06 +0200 |
commit | 3b6da997d6e3678167b1b8c9f4c5ccc2aa2d1fde (patch) | |
tree | 12a4d562b6dcd8224f0d942e2ed0903aebb1ad5d /doc/source | |
parent | 57dbdeddb17bdd46111c35937652f9a81a91a417 (diff) | |
download | oslo-context-3b6da997d6e3678167b1b8c9f4c5ccc2aa2d1fde.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: I4473e5e96419e4da9c8922d5832249da23c61acd
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
Diffstat (limited to 'doc/source')
-rw-r--r-- | 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 2767e5c..c3d54e3 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', ] @@ -75,6 +76,3 @@ latex_documents = [ openstackdocs_repo_name = 'openstack/oslo.context' openstackdocs_bug_project = 'oslo.context' openstackdocs_bug_tag = '' - -# Example configuration for intersphinx: refer to the Python standard library. -#intersphinx_mapping = {'http://docs.python.org/': None} |