Commit Graph

6 Commits

Author SHA1 Message Date
Takashi Kajinami 943a2f474c Fix warnings in doc build
This fixes the following two warnings detected by recent Sphinx.

1.
Invalid configuration value found: 'language = None'. Update your
configuration to a valid language code. Falling back to 'en' (English).

2.
WARNING: The pre-Sphinx 1.0 'intersphinx_mapping' format is deprecated
and will be removed in Sphinx 8. Update to the current format as
described in the documentation.

These warnings are treated as errors and `tox -e docs` fails.

Change-Id: I6bde5e865d6d750f878fe618ad8e947fc833d899
2023-09-07 19:48:13 +09:00
niuke d8e123228d remove unicode from code
Change-Id: Ief8896fd7244e29d4c471802b6734eac1e19447d
2022-07-28 08:58:56 +08:00
Hervé Beraud 89cb11c85c 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: I042162e9f303d2409491f71d3011db175930116d
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-09-15 15:19:35 +02:00
Andreas Jaeger dbf8dd6bcf [ussuri][goal] Drop python 2.7 support and testing
OpenStack is dropping the py2.7 support in ussuri cycle.

Complete discussion & schedule can be found in
- http://lists.openstack.org/pipermail/openstack-discuss/2019-October/010142.html
- https://etherpad.openstack.org/p/drop-python2-support

Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Switch to modern sphinx-build and using openstackdocstheme
(note that repo is not building and publishing docs, docs building works
locally with these changes).

Change-Id: I9542c1dba3f339c2acece83d7d2b5726c1c3e2bc
2020-02-03 17:12:24 +01:00
Chris Dent 2f044aae4e Include README.rst content on doc index
This is so there is at least some bare bones documentation to
start from.

Change-Id: I839e574bb1b52d16bc235d0437c60cff017d4594
2016-03-31 18:07:23 +01:00
Chris Dent 33e0066354 Enable gerrit, gitreview and gate testing
Initial setup for git review.

Add basic docs handling so that docs tests will pass. No
actual docs in place yet.

Align with global requirements.

Change-Id: I8ae7c2c6ce410c04f4ce53ce5278b2b85c141c93
2016-03-31 12:31:20 +01:00