openstack/zaqar
Code Issues Proposed changes

Use doc8 check

Browse Source 
doc8 is a linter for documents and used in openstack-manuals. It is better to
enforce document linters for simple checking.

The current rules are really simple like:
- line length check (80 chars)
- new line at the end of file
- Trailing whitespace

Change-Id: I328e2b2b82739696b95eca4a4130ca347893b0dc
This commit is contained in:
liuyamin 2017-08-09 18:43:33 +08:00
parent 900bdbe3d9
commit 49a397ebfb
14 changed files with 84 additions and 63 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
doc/source/admin/OSprofiler.rst
View File

@ -41,7 +41,8 @@ performance, so please set to disable in production environment.
**connection_string** **connection_string**
Connection string for a notifier backend. Default value is messaging:// which 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** **hmac_keys**

4
doc/source/admin/subscription_confirm.rst
View File

@ -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 before notification, this page is not hosted in Zaqar server, user should
build their own web service to provide this web page. 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. 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:: unsubscribe confirmation email content, including topic, body and sender too::
In the config file: In the config file:

3
doc/source/contributor/development.environment.rst
View File

@ -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/ .. _`MongoDB on Ubuntu installation guide`: http://docs.mongodb.org/manual/tutorial/install-mongodb-on-ubuntu/
On Fedora-based distributions, follow the instructions in the 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/ .. _`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/

2
doc/source/contributor/index.rst
View File

@ -40,4 +40,4 @@ layer.
In order to keep these layers decoupled, we have established that In order to keep these layers decoupled, we have established that
**checks should be performed in the appropriate layer**. In other words, **checks should be performed in the appropriate layer**. In other words,
transport drivers must guarantee that the incoming data is well-formed and transport drivers must guarantee that the incoming data is well-formed and
storage drivers must enforce their data model stays consistent. storage drivers must enforce their data model stays consistent.

99
doc/source/contributor/project_info.rst
View File

@ -23,15 +23,15 @@ Project Team Lead (PTL)
~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| Contact | Area of interest | | Contact | Area of interest |
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| | Feilong Wang | * Chief Architect | | | Feilong Wang | * Chief Architect |
| | flwang (irc) | * Release management | | | flwang (irc) | * Release management |
| | flwang@catalyst.net.nz | * Community management | | | flwang@catalyst.net.nz | * Community management |
| | flwang@qq.com | * Core team management | | | flwang@qq.com | * Core team management |
| | | * Road Map | | | | * Road Map |
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| *If you would like to refactor whole Zaqar or have UX/community/other | *If you would like to refactor whole Zaqar or have UX/community/other
issues please contact me.* issues please contact me.*
@ -40,24 +40,25 @@ Project Team Lead (PTL)
Project Core maintainers Project Core maintainers
~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| Contact | Area of interest | | Contact | Area of interest |
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| | Xiyuan Wang | * Zaqar related questions or bugs. | | | Xiyuan Wang | * Zaqar related questions or bugs. |
| | wxy (irc) UTC0200-UTC1000 | * Production problem for Zaqar. | | | wxy (irc) UTC0200-UTC1000 | * Production problem for Zaqar. |
| | wangxiyuan1007@gmail.com | * Integration with container. | | | wangxiyuan1007@gmail.com | * Integration with container. |
| | | | | | | |
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| | Hao Wang | * Introduce interesting and helpful features | | | Hao Wang | * Introduce interesting and helpful |
| | wanghao (irc) | * Bug Fix and Code Optimization | | | | features |
| | sxmatch1986@gmail.com | * Notification Service | | | wanghao (irc) | * Bug Fix and Code Optimization |
| | | | | | sxmatch1986@gmail.com | * Notification Service |
+------------------------------+------------------------------------------------+ | | | |
| | Thomas Herve | * Websocket | +------------------------------+---------------------------------------------+
| | therve (irc) | * Swift backend | | | Thomas Herve | * Websocket |
| | therve@redhat.com | | | | therve (irc) | * Swift backend |
| | | | | | therve@redhat.com | |
+------------------------------+------------------------------------------------+ | | | |
+------------------------------+---------------------------------------------+
| *All cores from this list are reviewing all changes that are proposed to Zaqar. | *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 To avoid duplication of efforts, please contact them before starting work on
@ -67,28 +68,28 @@ Project Core maintainers
Storage Backend Maintainers reviewers Storage Backend Maintainers reviewers
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| Contact | Area of interest | | Contact | Area of interest |
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| | Hao Wang | * MongoDB | | | Hao Wang | * MongoDB |
| | wanghao (irc) | | | | wanghao (irc) | |
| | sxmatch1986@gmail.com | | | | sxmatch1986@gmail.com | |
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| | gecong | * Swift | | | gecong | * Swift |
| | gecong (irc) | | | | gecong (irc) | |
| | ge.cong@zte.com.cn | | | | ge.cong@zte.com.cn | |
| | | | | | | |
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| | gengchc2 | * Redis | | | gengchc2 | * Redis |
| | gengchc (irc) | | | | gengchc (irc) | |
| | geng.changcai2@zte.com.cn | | | | geng.changcai2@zte.com.cn | |
| | | | | | | |
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| | Feilong Wang | * SqlAlchemy | | | Feilong Wang | * SqlAlchemy |
| | flwang (irc) | | | | flwang (irc) | |
| | flwang@catalyst.net.nz | | | | flwang@catalyst.net.nz | |
| | | | | | | |
+------------------------------+------------------------------------------------+ +------------------------------+---------------------------------------------+
| *All cores from this list are responsible for maintaining the storage backend. | *All cores from this list are responsible for maintaining the storage backend.
To avoid duplication of efforts, please contact them before starting working To avoid duplication of efforts, please contact them before starting working

2
doc/source/contributor/reviewer_guide.rst
View File

@ -162,4 +162,4 @@ bad designs, bad code, and bad blood.
.. _`Why this is important?` : https://thoughtstreams.io/kgriffs/technical-communities/5060/ .. _`Why this is important?` : https://thoughtstreams.io/kgriffs/technical-communities/5060/
.. _`OpenStack Documentation Contributor Guide` : http://docs.openstack.org/contributor-guide/index.html .. _`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: 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 .. _`Wikipedia: You aren't gonna need it` : https://en.wikipedia.org/wiki/Don't_repeat_yourself

3
doc/source/glossary.rst
View File

@ -19,7 +19,8 @@ Messaging Service Concepts
========================== ==========================
The Messaging Service is a multi-tenant, message queue implementation that The Messaging Service is a multi-tenant, message queue implementation that
utilizes a RESTful HTTP interface to provide an asynchronous communications 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:: .. glossary::

6
doc/source/install/index.rst
View File

@ -25,7 +25,8 @@ Installation Guide.
Ocata 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 <https://docs.openstack.org/project-install-guide/messaging/ocata/install-ubuntu.html>`__ - `Ubuntu <https://docs.openstack.org/project-install-guide/messaging/ocata/install-ubuntu.html>`__
- `CentOS and RHEL <https://docs.openstack.org/project-install-guide/messaging/ocata/install-rdo.html>`__ - `CentOS and RHEL <https://docs.openstack.org/project-install-guide/messaging/ocata/install-rdo.html>`__
@ -34,7 +35,8 @@ To install Glance, see the Ocata Image service install guide for each distributi
Newton 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 <https://docs.openstack.org/project-install-guide/messaging/newton/install-ubuntu.html>`__ - `Ubuntu <https://docs.openstack.org/project-install-guide/messaging/newton/install-ubuntu.html>`__
- `CentOS and RHEL <https://docs.openstack.org/project-install-guide/messaging/newton/install-rdo.html>`__ - `CentOS and RHEL <https://docs.openstack.org/project-install-guide/messaging/newton/install-rdo.html>`__

2
doc/source/user/send_request_api.rst
View File

@ -52,7 +52,7 @@ the examples.
the ``PUT`` request method. the ``PUT`` request method.
**Note** If you have the tools, you can run the cURL JSON request examples **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:
``<curl JSON request example> | python -mjson.tool``. ``<curl JSON request example> | python -mjson.tool``.
Copying and Pasting cURL Request Examples into a Terminal Window Copying and Pasting cURL Request Examples into a Terminal Window

2
releasenotes/notes/deprecate-v11-976cccc1b56a28e7.yaml
View File

@ -3,4 +3,4 @@ deprecations:
- Zaqar API v2 has been released for several cycles and it is integrated - 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 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 to deprecated v1.1 in favor of v2. Now in Newton cycle, Zaqar API v1.1 is
officially deprecated. officially deprecated.

2
releasenotes/notes/support-cors-af8349382a44aa0d.yaml
View File

@ -1,3 +1,3 @@
--- ---
features: features:
- Zaqar now supports Cross-Origin Resource Sharing (CORS). - Zaqar now supports Cross-Origin Resource Sharing (CORS).

2
releasenotes/source/liberty.rst
View File

@ -3,4 +3,4 @@
============================== ==============================
.. release-notes:: .. release-notes::
:branch: origin/stable/liberty :branch: origin/stable/liberty

1
test-requirements.txt
View File

@ -17,6 +17,7 @@ PyMySQL>=0.7.6 # MIT License
# Unit testing # Unit testing
coverage!=4.4,>=4.0 # Apache-2.0 coverage!=4.4,>=4.0 # Apache-2.0
ddt>=1.0.1 # MIT ddt>=1.0.1 # MIT
doc8 # Apache-2.0
fixtures>=3.0.0 # Apache-2.0/BSD fixtures>=3.0.0 # Apache-2.0/BSD
python-subunit>=0.0.18 # Apache-2.0/BSD python-subunit>=0.0.18 # Apache-2.0/BSD
testscenarios>=0.4 # Apache-2.0/BSD testscenarios>=0.4 # Apache-2.0/BSD

16
tox.ini
View File

@ -45,6 +45,7 @@ commands = {posargs}
[testenv:docs] [testenv:docs]
commands = commands =
doc8 doc/source
python setup.py build_sphinx python setup.py build_sphinx
sphinx-build -W -b html api-ref/source api-ref/build/html sphinx-build -W -b html api-ref/source api-ref/build/html
@ -62,7 +63,9 @@ commands =
commands = oslo_debug_helper {posargs} commands = oslo_debug_helper {posargs}
[testenv:releasenotes] [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] [flake8]
exclude = .venv*,.git,.tox,dist,doc,*lib/python*,*.egg,.update-venv 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. # [H904] Delay string interpolations at logging calls.
enable-extensions=H904 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] [hacking]
local-check-factory = zaqar.hacking.checks.factory local-check-factory = zaqar.hacking.checks.factory