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: I5190044fed75d4c68e9d2686d9ab67b2afa0f9e0
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
Switch to openstackdocstheme 2.2.0 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
Update Sphinx version as well.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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.
Set openstackdocs_auto_name to use project as name.
Depends-On: https://review.opendev.org/728938
Change-Id: I11c609d70b7a020547b1897cce60a7a2365e7dd8
it is not only useless to an end user but it also
includes random/non-deterministic contents.
This change makes the build reproducible.
See https://reproducible-builds.org/ for why this is good.
Change-Id: Ie40178da80161839379aa9762cd7a5361b44953b
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.
[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045
Change-Id: Ied545a35429a87dc32b746ed54595311d903fea2
According to I8ae8507a089df4d0a32be5fbc615e2166f44516e the config option
multi_instance_display_name_template has been removed.
So this patch removes the remaining of the option.
Change-Id: I3f92add2f4505424264356a7ab832855c8971550
According to [1], "auth_uri" has been deprecated.
This patch replace it by using "www_authenticate_uri" instead.
[1] https://review.openstack.org/#/c/508522
Change-Id: Ic490c9a1262c7aaae2c40b5c2b22b3a66ba294f1
On SELinux-enabled platforms it is possible for the report process
to fail with an AccessDenied error when it tries to read information
about the process being debugged. Per [1], the recommended solution
is to temporarily disable SELinux during debugging and then turn it
on again once the report has completed successfully.
1: https://bugzilla.redhat.com/show_bug.cgi?id=1292787
Change-Id: Ic12d5658858bb085448e1b437b548111d3c79583
Closes-Bug: 1756044
Add automatically generated documentation for the configuration options
using oslo_config.sphinxext.
Change-Id: I9525a637bc284beaf22e48e80b5c2f8ba7872a8e
niuke