Commit Graph

30 Commits

Author SHA1 Message Date
niuke 968f8cc8df remove unicode literal from code
Change-Id: I2a0271618074ceb68fed716da347ad5fde217a28
2022-07-28 10:24:35 +00:00
Hervé Beraud cef0e7cc4c 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: I593196cf0d099fe1dcc3a6298fd6cc6b7a883ea2
Signed-off-by: Moisés Guimarães de Medeiros <moguimar@redhat.com>
2020-09-08 12:28:20 +02:00
Zuul 7b84e7d530 Merge "Add release notes links to doc index" 2020-05-26 13:50:27 +00:00
Andreas Jaeger 39c29f6229 Switch to newer openstackdocstheme and reno versions
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
2020-05-18 20:54:49 +02:00
Hervé Beraud 8af78e7e57 Add release notes links to doc index
Change-Id: I56708cf43ea422a8ce1e69e41130d04f4ea42cbb
2020-04-16 17:52:23 +02:00
Hervé Beraud 2961c30bce [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

Change-Id: I4b1f1b65d21340e76971d2bf31ee79d97392c454
Sem-Ver: api-break
2020-02-04 17:16:27 +01:00
caoyuan 127ded28c9 tox: Keeping going with docs
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
2019-10-24 14:50:28 +08:00
ZhongShengping c59246530f Follow the new PTI for document build
For compliance with the Project Testing Interface as described in:

https://governance.openstack.org/tc/reference/project-testing-interface.html

For more detailed information, please refer to:

http://lists.openstack.org/pipermail/openstack-dev/2017-December/125710.html

Change-Id: Id20646cd51ffc13cf4e77c640eb677fe376c1b1f
Co-Authored-By: Stephen Finucane <stephenfin@redhat.com>
2019-07-19 10:56:20 +01:00
Sean McGinnis 2bba6767c0
Fix doc build error under Python 3
Small fix to switch "print foo" to "print(foo)".

Change-Id: Ib49a5e9420a4ab2ab62db2886a78c070ff6c5ba0
Signed-off-by: Sean McGinnis <sean.mcginnis@gmail.com>
2019-04-10 09:50:37 -05:00
zhang.lei afe8fa515c Fix the repeating titles
The Index page of reference guide[1] takes repeating titles,
All titles show up twice. This patch is to fix it.

[1] https://docs.openstack.org/oslo.vmware/latest/reference/index.html

Change-Id: I03f3bf6f37f9ac9038657cfc9ee98015f673caaf
Closes-Bug: #1735398
2017-12-07 09:34:09 +08:00
Akihiro Motoki a1598502bd rearrange existing documentation to fit the new standard layout
For more detail, see the doc migration spec:
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
There is also the recent status of the work posted in the dev ML:
http://lists.openstack.org/pipermail/openstack-dev/2017-July/119221.html

Change-Id: I1e728fc0bc671150d826747010eb980176f0cc13
2017-07-11 14:11:12 +00:00
Akihiro Motoki 01443b8380 Switch from oslosphinx to openstackdocstheme
Change-Id: Ic1e2786783fa47f305f8a849d36648efe3e46ac4
2017-07-11 14:11:11 +00:00
Eric Brown 355d4a28f9 Trivial fixes to the usage doc
Removed the extra = in the doc title.

Change-Id: Ib51d40622be629a2776c8f7d72df94525a431dbe
2016-10-28 03:20:45 -07:00
Doug Hellmann bf7ce8c560 do not show the full release history in the main table of contents
Change-Id: I2154abea5c92d28e2261f594d84ea37b0efb4c4b
2015-09-24 19:52:43 +00:00
Doug Hellmann 7eb50814f1 clean up readme and documentation titles
Change-Id: I75775878f190e65b0eedc6d0d7c9de741a979f78
2015-09-24 19:52:18 +00:00
zhu.rong 44442d3b83 Update the documentation
Now the CONTRIBUTING.rst have no title, and the readme.rst include
the wrong path.

This patch fix it.

Change-Id: I463d57e45eff3708f1ee0d74caa51fe64b1b0d41
2015-09-06 09:24:47 +08:00
Ryan Hsu 9df58d2d6a Make usage doc easier to understand for library consumers
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
2015-07-24 11:45:59 -07:00
Eric Brown 9ed4d8a7d2 Correct usage to oslo_vmware
The recently updated usage doc should reference oslo_vmware not
oslo.vmware.

bp/drop-namespace-packages

Change-Id: Ib3be81df6de7d42067ec69a7a811f6fe5def9241
2015-01-26 13:54:36 -08:00
Jenkins 3a5518d588 Merge "Fix missing project name in installation doc" 2015-01-24 03:24:02 +00:00
Eric Brown 95de8baa0c Correct the doc usage example
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
2015-01-23 15:05:51 -08:00
Ryan Hsu c4fa9f3671 Fix missing project name in installation doc
Currently, the installation doc is missing the project name for
the pip install command. This commit adds the correct project
name.

Change-Id: I5c65d36344b52c74d8fb823c3bb2703ba097a743
2015-01-23 14:54:18 -08:00
Davanum Srinivas 73d116001b Fixup autoindex.rst only if it exists
Closes-Bug: #1370370

Change-Id: I05638808b577db8e96e5b83aa8b5a9c47f8170c1
2014-10-07 12:51:25 +00:00
Davanum Srinivas df59368f76 Switch to using oslo.utils
Change-Id: If97d1d95341db9fbc33f6824ff326ee3fc64d8ee
2014-09-25 11:55:30 -04:00
Davanum Srinivas 5571e9f435 Enable oslo.i18n for oslo.vmware
Change-Id: Ie6c8406bf55a4fb96373cdd3e1a2f5b3c2aafe59
2014-09-10 09:38:57 -04:00
Davanum Srinivas ffd9a6de0c Add docs target and generate api docs
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
2014-09-04 21:32:18 -04:00
Jenkins aeb7486db8 Merge "remove definitions of Python Source Code Encoding" 2014-06-19 08:44:07 +00:00
Christian Berendt 64d855f96c remove definitions of Python Source Code Encoding
I think PEP 0263 (http://legacy.python.org/dev/peps/pep-0263/) is
not used anywhere else and so it should be removed.

Change-Id: I24f069441d2297eb093697a83bf420f5ce455156
2014-06-08 18:44:02 +02:00
Christian Berendt 46f9661628 cleaning up index.rst file
Removed notes about the generation of the file and fixed the title.

Change-Id: Idc386415362e608c8fb3b1d215ceff4a32792d6a
2014-05-28 10:02:34 +02:00
Davanum Srinivas d1a383c25b Import necessary files from openstack.common
First cut of openstack-common.conf to pick up a few
files needed by the patch series

Change-Id: I148ff1e0e28df8b732a7865e162e5104a4233b7d
Implements: blueprint vmware-api
2014-02-20 06:50:26 -05:00
Davanum Srinivas ac90aad85a Initial checkin for Oslo VMware Library generated using oslo-cookiecutter 2014-02-03 09:48:20 -05:00