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: I593196cf0d099fe1dcc3a6298fd6cc6b7a883ea2
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.
Depends-On: https://review.opendev.org/728938
Change-Id: I6e7adce626eeba8010c915bf579b79e07ea645cf
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: I390f8f7add7530f1442f66816389202e3ed21f05
Small fix to switch "print foo" to "print(foo)".
Change-Id: Ib49a5e9420a4ab2ab62db2886a78c070ff6c5ba0
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
Now the CONTRIBUTING.rst have no title, and the readme.rst include
the wrong path.
This patch fix it.
Change-Id: I463d57e45eff3708f1ee0d74caa51fe64b1b0d41
This change makes a few modifications to make the usage doc easier
to understand and consume for users of the oslo.vmware library.
Among the changes are explanations for parameters, extra helpful
comments, removing references to default arguments to simplify the
example.
Change-Id: Iccbe40f6bda0c65c3de87d708634ae6bbdcaa959
The recently updated usage doc should reference oslo_vmware not
oslo.vmware.
bp/drop-namespace-packages
Change-Id: Ib3be81df6de7d42067ec69a7a811f6fe5def9241
The docs contain an invalid import as an example of the usage
of the oslo.vmware library. This patch corrects the import and
puts a small, more meaningful example in its place.
Change-Id: I8ae1d112d2d58115f13c3531b98c91f36f2e7d15
Currently, the installation doc is missing the project name for
the pip install command. This commit adds the correct project
name.
Change-Id: I5c65d36344b52c74d8fb823c3bb2703ba097a743
Once we use the pbr based build to generate files, we prune
the indexes to remove references to code we would like to
hide like the common modules and private modules in conf.py.
We reuse the same excluded_patterns variable that is already
used in Sphinx and filter these modules from autoindex.rst
Closes-Bug: #1364140
Change-Id: I5767e429e63935f055a6f4e82349224ccfa2f497
First cut of openstack-common.conf to pick up a few
files needed by the patch series
Change-Id: I148ff1e0e28df8b732a7865e162e5104a4233b7d
Implements: blueprint vmware-api