Commit Graph

31 Commits

Author SHA1 Message Date
songwenping b036fc1141 Remove unnecessary unicode prefixes
Change-Id: Id6bb6fb85f9989746066ac042661cd4782f153c4
2022-04-19 19:43:00 +08:00
dengzhaosen 0fc0a0a257 Ussuri+ is python3 only and update python to python3
Change-Id: I504494cac13fb8b887df16fe6b93bf587ba35630
2021-05-06 10:19:03 +08:00
Hervé Beraud 3b6da997d6 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>
2020-09-08 14:01:06 +02:00
melissaml ffb62b9d49 Fix pygments style
New theme of docs respects pygments_style.

more info: http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I69a051117890860e3dc524a6361f5acb21820a02
2020-06-04 14:34:20 +08:00
Zuul ce2c97d96b Merge "Add release notes links to doc index" 2020-05-26 13:50:35 +00:00
Andreas Jaeger 872d02b23c 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 problems

Update Sphinx version as well.

openstackdocstheme renames some variables, so follow the renames. A
couple of variables are also not needed anymore, remove them.

Depends-On: https://review.opendev.org/728938
Change-Id: If23ebf2dcf6304d5ea50c5e427bfad217ce0d235
2020-05-18 21:06:45 +02:00
Hervé Beraud d5e7126a36 Add release notes links to doc index
Change-Id: I2e1fa7512529c90a5ada0402483849837bd2e14d
2020-04-16 17:15:28 +02:00
pengyuesheng 3017e180f0 Drop python 2.7 support and testing
Ussuri Communtiy-wide goal:
https://governance.openstack.org/tc/goals/selected/ussuri/drop-py27.html

Change-Id: Ie875138bd1b773f460698e1eacc9dab542318e30
Sem-Ver: api-break
2020-01-30 11:43:11 +00:00
pengyuesheng 39923ae345 Bump the openstackdocstheme extension to 1.20
Some options are now automatically configured by the version 1.20:

- project
- html_last_updated_fmt
- latex_engine
- latex_elements
- version
- release

Note that we don't actually drop 'project' since it's referenced
elsewhere in the file and cleaning that up would be hassle.

Change-Id: Ibe4add5a9391c3b3bc49206c9ac65721cedddf5a
2019-12-19 09:13:54 +00:00
Stephen Finucane ca925b108c tox: Stop using 'python setup.py test'
pbr has deprecated this. Call stestr directly instead.

Change-Id: I26628e4734c6d7a911fbe16ad753173a36fd8dab
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
2019-12-06 15:06:18 +00:00
caoyuan 5c5df03d0b 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: I07690fb61001eb282d895fbbac4cd856defe6581
2019-10-24 14:30:47 +08:00
Ben Nemec 016904f816 Cap Bandit below 1.6.0 and update Sphinx requirement
Bandit 1.6.0 accidentally changed how the exclusion list option is
handled and breaks our use of it. Cap to the previous version until
Bandit has fixed the problem.

Sphinx 2.0 no longer works on python 2.7, so we need to start capping
it there as well.

Change-Id: Ib7f8df3fc5b83520b179d0a260c54e015c042b17
Reference: https://github.com/PyCQA/bandit/pull/489
2019-05-13 18:02:21 +00:00
jacky06 dd33e2a2c8 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: Iaf18cea9ee9f1edfd1ef1a96a36de1569e399886
2019-04-30 13:30:33 +08:00
OpenStack Proposal Bot cdbd6566dc Updated from global requirements
Change-Id: I1c0eedc5c321d2c847510a503f0a25e8382f1648
2018-03-15 07:47:51 +00:00
OpenStack Proposal Bot 1a9a54d1a1 Updated from global requirements
Change-Id: Ibfbb20b4e06815bc4ebd4dd7b3a60501fbf7cdcb
2018-01-24 01:25:05 +00:00
OpenStack Proposal Bot c594e71cb7 Updated from global requirements
Change-Id: Ia41f791b8bde7b82d37f4de47d05d1b6ba4e6053
2018-01-18 03:23:13 +00:00
OpenStack Proposal Bot bfdeba62be Updated from global requirements
Change-Id: Idf473d822b830c808c6007bd6d82257fb7305e0a
2018-01-04 06:52:33 +00:00
ChangBo Guo(gcb) f0dd124daa 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 detials information, please refer to:

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

Change-Id: I9d23ea7b5731fb677b2b1a09cdec74a1101dcd2c
2017-12-19 19:00:49 +08:00
lingyongxu 15a6c74bf5 Update the documentation link for doc migration
This patch is proposed according to the Direction 10 of doc
migration(https://etherpad.openstack.org/p/doc-migration-tracking).

Change-Id: Ib60419cfcea0736f68960e3c94b83508e9f77ae1
2017-08-28 15:30:36 +08:00
ChangBo Guo(gcb) e86ee74a72 Fix URLs according to document migration
Change-Id: I5e452dfc33c4bdf8f344f6e28ff1fd4a5e049476
2017-07-12 22:46:06 +08:00
Akihiro Motoki fd6b1c82f2 Cleanup document formatting
- Previously the title of the top page was Team and repository tags.
  It was completely wrong.
- Remove spaces before URLs in CONTRIBUTING.rst.
  In openstackdocstheme, we have vertical lines for quote blocks.
  Removing unnecessary spaces improves the visibility of rendered HTML.
- Use appropriate highlighting style for code blocks.

Change-Id: Ib0d2e4699767e7b52b015c328c366202b3e5ddc8
2017-07-05 02:27:14 +09:00
Akihiro Motoki cdb50bed6e rearrange the documentation to fit into the new standard layout
Change-Id: If9bd83a0ac47084e025899cee681feef06265406
2017-07-05 01:57:01 +09:00
Van Hung Pham 3ce185402e Switch from oslosphinx to openstackdocstheme
As part of the docs migration work[0] for Pike we need to switch to use
the openstackdocstheme.

[0]https://review.openstack.org/#/c/472275/

Change-Id: I2ac1a1b9899b8bcb939fb287f09e7c69caca7fc9
2017-06-29 10:40:24 +07:00
Van Hung Pham d0f8de0eb6 Optimize the link address
Update link address to ensure safety and preciseness

Change-Id: Id193a5cefa3220036df69f5ca48aadc7ae02890b
2017-06-13 10:20:56 +07:00
Sean Dague ec7cdc4cc5 Add global_request_id to context
This provides the facility to have a global_request_id which is
different from the service level request_id that we've been using.

Includes basic testing.

Change-Id: I1521188ae627fa2e7d35aa2ffffbcb620c527765
2017-05-23 10:22:34 -04:00
Atsushi SAKAI 1bccf39338 Fix typos
respository     => repository
respresentative => representative

Change-Id: I2f139cb9fb67ddd304be6d3df0b4a51baf43b783
2016-08-23 22:20:57 +09:00
Ronald Bradford b621d4eecc Improve Context docs with example syntax
Added examples to explain how use Oslo Context with Oslo Log.

Change-Id: I5b5d2ee152b305316b68c5b34d00f480c7daf5ba
2016-01-29 20:45:46 +00:00
Doug Hellmann ecac38aa90 Documentation cleanup
Tidy up filenames, layout, and other minor issues with the documentation
before our first release.

bp/graduate-oslo-context

Change-Id: Ib284bbdb50f868b232abc050311ddd5a9d9bde15
2014-11-19 12:05:17 -05:00
Doug Hellmann fc2d39034b Add ClearRequestContext fixture
Add a fixture class for use in tests to provide a way to flush the
cached RequestContext without exposing how that is stored.

bp/graduate-oslo-context

Change-Id: I27dd50a61d364e1698823629e2676c10ced50af3
2014-11-19 11:58:56 -05:00
Davanum Srinivas 30b096448f Generate better documentation for the module
Change-Id: Ibad798b09ac1227065173b3b1843cc3b6bfbaf80
2014-11-19 08:24:08 -05:00
Davanum Srinivas 885f545d81 exported from oslo-incubator by graduate.sh 2014-11-05 15:03:32 +01:00