diff --git a/doc/source/admin/OSprofiler.rst b/doc/source/admin/OSprofiler.rst index 70d8d1968..a984d0e01 100644 --- a/doc/source/admin/OSprofiler.rst +++ b/doc/source/admin/OSprofiler.rst @@ -41,7 +41,8 @@ performance, so please set to disable in production environment. **connection_string** Connection string for a notifier backend. Default value is messaging:// which -sets the notifier to oslo_messaging. Here we set it to "mongodb://localhost:27017" +sets the notifier to oslo_messaging. Here we set it to +"mongodb://localhost:27017" **hmac_keys** diff --git a/doc/source/admin/subscription_confirm.rst b/doc/source/admin/subscription_confirm.rst index 54e3160d9..eb2bcbf99 100644 --- a/doc/source/admin/subscription_confirm.rst +++ b/doc/source/admin/subscription_confirm.rst @@ -227,10 +227,10 @@ The confirmation page url that will be used in email subscription confirmation before notification, this page is not hosted in Zaqar server, user should build their own web service to provide this web page. -The subscription_confirmation_email_template let user to customize the +The subscription_confirmation_email_template let user to customize the subscription confirmation email content, including topic, body and sender. -The unsubscribe_confirmation_email_template let user to customize the +The unsubscribe_confirmation_email_template let user to customize the unsubscribe confirmation email content, including topic, body and sender too:: In the config file: diff --git a/doc/source/contributor/development.environment.rst b/doc/source/contributor/development.environment.rst index 52e6d9898..bf052688a 100644 --- a/doc/source/contributor/development.environment.rst +++ b/doc/source/contributor/development.environment.rst @@ -78,7 +78,8 @@ On Ubuntu, follow the instructions in the .. _`MongoDB on Ubuntu installation guide`: http://docs.mongodb.org/manual/tutorial/install-mongodb-on-ubuntu/ On Fedora-based distributions, follow the instructions in the -`MongoDB on Red Hat Enterprise, CentOS, Fedora, or Amazon Linux Installation Guide`_. +`MongoDB on Red Hat Enterprise, CentOS, Fedora, or Amazon Linux +Installation Guide`_. .. _`MongoDB on Red Hat Enterprise, CentOS, Fedora, or Amazon Linux installation guide`: http://docs.mongodb.org/manual/tutorial/install-mongodb-on-red-hat-centos-or-fedora-linux/ diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst index d91539f72..36ab04e6f 100644 --- a/doc/source/contributor/index.rst +++ b/doc/source/contributor/index.rst @@ -40,4 +40,4 @@ layer. In order to keep these layers decoupled, we have established that **checks should be performed in the appropriate layer**. In other words, transport drivers must guarantee that the incoming data is well-formed and -storage drivers must enforce their data model stays consistent. \ No newline at end of file +storage drivers must enforce their data model stays consistent. diff --git a/doc/source/contributor/project_info.rst b/doc/source/contributor/project_info.rst index aa9c0acab..823b1c19b 100644 --- a/doc/source/contributor/project_info.rst +++ b/doc/source/contributor/project_info.rst @@ -23,15 +23,15 @@ Project Team Lead (PTL) ~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------+------------------------------------------------+ -| Contact | Area of interest | -+------------------------------+------------------------------------------------+ -| | Feilong Wang | * Chief Architect | -| | flwang (irc) | * Release management | -| | flwang@catalyst.net.nz | * Community management | -| | flwang@qq.com | * Core team management | -| | | * Road Map | -+------------------------------+------------------------------------------------+ ++------------------------------+---------------------------------------------+ +| Contact | Area of interest | ++------------------------------+---------------------------------------------+ +| | Feilong Wang | * Chief Architect | +| | flwang (irc) | * Release management | +| | flwang@catalyst.net.nz | * Community management | +| | flwang@qq.com | * Core team management | +| | | * Road Map | ++------------------------------+---------------------------------------------+ | *If you would like to refactor whole Zaqar or have UX/community/other issues please contact me.* @@ -40,24 +40,25 @@ Project Team Lead (PTL) Project Core maintainers ~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------+------------------------------------------------+ -| Contact | Area of interest | -+------------------------------+------------------------------------------------+ -| | Xiyuan Wang | * Zaqar related questions or bugs. | -| | wxy (irc) UTC0200-UTC1000 | * Production problem for Zaqar. | -| | wangxiyuan1007@gmail.com | * Integration with container. | -| | | | -+------------------------------+------------------------------------------------+ -| | Hao Wang | * Introduce interesting and helpful features | -| | wanghao (irc) | * Bug Fix and Code Optimization | -| | sxmatch1986@gmail.com | * Notification Service | -| | | | -+------------------------------+------------------------------------------------+ -| | Thomas Herve | * Websocket | -| | therve (irc) | * Swift backend | -| | therve@redhat.com | | -| | | | -+------------------------------+------------------------------------------------+ ++------------------------------+---------------------------------------------+ +| Contact | Area of interest | ++------------------------------+---------------------------------------------+ +| | Xiyuan Wang | * Zaqar related questions or bugs. | +| | wxy (irc) UTC0200-UTC1000 | * Production problem for Zaqar. | +| | wangxiyuan1007@gmail.com | * Integration with container. | +| | | | ++------------------------------+---------------------------------------------+ +| | Hao Wang | * Introduce interesting and helpful | +| | | features | +| | wanghao (irc) | * Bug Fix and Code Optimization | +| | sxmatch1986@gmail.com | * Notification Service | +| | | | ++------------------------------+---------------------------------------------+ +| | Thomas Herve | * Websocket | +| | therve (irc) | * Swift backend | +| | therve@redhat.com | | +| | | | ++------------------------------+---------------------------------------------+ | *All cores from this list are reviewing all changes that are proposed to Zaqar. To avoid duplication of efforts, please contact them before starting work on @@ -67,28 +68,28 @@ Project Core maintainers Storage Backend Maintainers reviewers ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -+------------------------------+------------------------------------------------+ -| Contact | Area of interest | -+------------------------------+------------------------------------------------+ -| | Hao Wang | * MongoDB | -| | wanghao (irc) | | -| | sxmatch1986@gmail.com | | -+------------------------------+------------------------------------------------+ -| | gecong | * Swift | -| | gecong (irc) | | -| | ge.cong@zte.com.cn | | -| | | | -+------------------------------+------------------------------------------------+ -| | gengchc2 | * Redis | -| | gengchc (irc) | | -| | geng.changcai2@zte.com.cn | | -| | | | -+------------------------------+------------------------------------------------+ -| | Feilong Wang | * SqlAlchemy | -| | flwang (irc) | | -| | flwang@catalyst.net.nz | | -| | | | -+------------------------------+------------------------------------------------+ ++------------------------------+---------------------------------------------+ +| Contact | Area of interest | ++------------------------------+---------------------------------------------+ +| | Hao Wang | * MongoDB | +| | wanghao (irc) | | +| | sxmatch1986@gmail.com | | ++------------------------------+---------------------------------------------+ +| | gecong | * Swift | +| | gecong (irc) | | +| | ge.cong@zte.com.cn | | +| | | | ++------------------------------+---------------------------------------------+ +| | gengchc2 | * Redis | +| | gengchc (irc) | | +| | geng.changcai2@zte.com.cn | | +| | | | ++------------------------------+---------------------------------------------+ +| | Feilong Wang | * SqlAlchemy | +| | flwang (irc) | | +| | flwang@catalyst.net.nz | | +| | | | ++------------------------------+---------------------------------------------+ | *All cores from this list are responsible for maintaining the storage backend. To avoid duplication of efforts, please contact them before starting working diff --git a/doc/source/contributor/reviewer_guide.rst b/doc/source/contributor/reviewer_guide.rst index 90517c372..adb4d81d8 100644 --- a/doc/source/contributor/reviewer_guide.rst +++ b/doc/source/contributor/reviewer_guide.rst @@ -162,4 +162,4 @@ bad designs, bad code, and bad blood. .. _`Why this is important?` : https://thoughtstreams.io/kgriffs/technical-communities/5060/ .. _`OpenStack Documentation Contributor Guide` : http://docs.openstack.org/contributor-guide/index.html .. _`Wikipedia: Don't repeat yourself` : https://en.wikipedia.org/wiki/Don't_repeat_yourself -.. _`Wikipedia: You aren't gonna need it` : https://en.wikipedia.org/wiki/Don't_repeat_yourself \ No newline at end of file +.. _`Wikipedia: You aren't gonna need it` : https://en.wikipedia.org/wiki/Don't_repeat_yourself diff --git a/doc/source/glossary.rst b/doc/source/glossary.rst index 7890fc5f2..57f46c9a7 100644 --- a/doc/source/glossary.rst +++ b/doc/source/glossary.rst @@ -19,7 +19,8 @@ Messaging Service Concepts ========================== The Messaging Service is a multi-tenant, message queue implementation that utilizes a RESTful HTTP interface to provide an asynchronous communications -protocol, which is one of the main requirements in today’s scalable applications. +protocol, which is one of the main requirements in today’s scalable +applications. .. glossary:: diff --git a/doc/source/install/index.rst b/doc/source/install/index.rst index 89b85bbfe..86fb6b23a 100644 --- a/doc/source/install/index.rst +++ b/doc/source/install/index.rst @@ -25,7 +25,8 @@ Installation Guide. Ocata ~~~~~ -To install Glance, see the Ocata Image service install guide for each distribution: +To install Glance, see the Ocata Image service install guide for each +distribution: - `Ubuntu `__ - `CentOS and RHEL `__ @@ -34,7 +35,8 @@ To install Glance, see the Ocata Image service install guide for each distributi Newton ~~~~~~ -To install Glance, see the Newton Image service install guide for each distribution: +To install Glance, see the Newton Image service install guide for each +distribution: - `Ubuntu `__ - `CentOS and RHEL `__ diff --git a/doc/source/user/send_request_api.rst b/doc/source/user/send_request_api.rst index 22e35a406..bd03e63aa 100644 --- a/doc/source/user/send_request_api.rst +++ b/doc/source/user/send_request_api.rst @@ -52,7 +52,7 @@ the examples. the ``PUT`` request method. **Note** If you have the tools, you can run the cURL JSON request examples -with the following options to format the output from cURL: +with the following options to format the output from cURL: `` | python -mjson.tool``. Copying and Pasting cURL Request Examples into a Terminal Window diff --git a/releasenotes/notes/deprecate-v11-976cccc1b56a28e7.yaml b/releasenotes/notes/deprecate-v11-976cccc1b56a28e7.yaml index 027ea925e..75a2d93e5 100644 --- a/releasenotes/notes/deprecate-v11-976cccc1b56a28e7.yaml +++ b/releasenotes/notes/deprecate-v11-976cccc1b56a28e7.yaml @@ -3,4 +3,4 @@ deprecations: - Zaqar API v2 has been released for several cycles and it is integrated as the default API version by most of the OpenStack services. So it is time to deprecated v1.1 in favor of v2. Now in Newton cycle, Zaqar API v1.1 is - officially deprecated. \ No newline at end of file + officially deprecated. diff --git a/releasenotes/notes/support-cors-af8349382a44aa0d.yaml b/releasenotes/notes/support-cors-af8349382a44aa0d.yaml index d4663153d..463801ef8 100644 --- a/releasenotes/notes/support-cors-af8349382a44aa0d.yaml +++ b/releasenotes/notes/support-cors-af8349382a44aa0d.yaml @@ -1,3 +1,3 @@ --- features: - - Zaqar now supports Cross-Origin Resource Sharing (CORS). \ No newline at end of file + - Zaqar now supports Cross-Origin Resource Sharing (CORS). diff --git a/releasenotes/source/liberty.rst b/releasenotes/source/liberty.rst index 08cd4ee64..36217be84 100644 --- a/releasenotes/source/liberty.rst +++ b/releasenotes/source/liberty.rst @@ -3,4 +3,4 @@ ============================== .. release-notes:: - :branch: origin/stable/liberty \ No newline at end of file + :branch: origin/stable/liberty diff --git a/test-requirements.txt b/test-requirements.txt index 107ff53d9..55cc8b63b 100644 --- a/test-requirements.txt +++ b/test-requirements.txt @@ -17,6 +17,7 @@ PyMySQL>=0.7.6 # MIT License # Unit testing coverage!=4.4,>=4.0 # Apache-2.0 ddt>=1.0.1 # MIT +doc8 # Apache-2.0 fixtures>=3.0.0 # Apache-2.0/BSD python-subunit>=0.0.18 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD diff --git a/tox.ini b/tox.ini index a65c6264e..e83c8363c 100644 --- a/tox.ini +++ b/tox.ini @@ -45,6 +45,7 @@ commands = {posargs} [testenv:docs] commands = + doc8 doc/source python setup.py build_sphinx sphinx-build -W -b html api-ref/source api-ref/build/html @@ -62,7 +63,9 @@ commands = commands = oslo_debug_helper {posargs} [testenv:releasenotes] -commands = sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html +commands = + doc8 releasenotes/source releasenotes/notes + sphinx-build -a -E -d releasenotes/build/doctrees -b html releasenotes/source releasenotes/build/html [flake8] exclude = .venv*,.git,.tox,dist,doc,*lib/python*,*.egg,.update-venv @@ -72,5 +75,16 @@ max-complexity = 16 # [H904] Delay string interpolations at logging calls. enable-extensions=H904 +[doc8] +# File extensions to check +extensions = .rst, .yaml +# Maximal line length should be 80 but we have some overlong lines. +# Let's not get far more in. +max-line-length = 80 +# Disable some doc8 checks: +# D000: Check RST validity +# - cannot handle "none" for code-block directive +ignore = D000 + [hacking] local-check-factory = zaqar.hacking.checks.factory