Update tox.ini to align with other manila repos
so that we can run 'tox' locally and properly validate our spec docs. * Update tox minversion and requirements * Clean out build directory before new docs build * Run doc8 validation * Fix numerous incidental errors in the specs and templates so that doc8 now passes * Setup both py35 and py27 environments * Turn off yasfb extension until it can work with python 3 Change-Id: I722a9ad852cdfa0974322fbe29db37956dab3ee0
This commit is contained in:
Tom Barron
parent
0e007e65c3
commit
3c669be677
@ -25,7 +25,10 @@ extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.graphviz',
|
||||
'oslosphinx',
|
||||
'yasfb',
|
||||
# TODO(tbarron): re-enable yasfb after
|
||||
# https://github.com/sphinxcontrib/yasfb/commit/62d18c66835320af4a71fb088cb502041478fb16
|
||||
# is released; it currently breaks with python 3.5
|
||||
#'yasfb',
|
||||
]
|
||||
|
||||
# Feed configuration for yasfb
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
pbr>=0.11,<2.0
|
||||
oslosphinx
|
||||
sphinx>=1.1.2,!=1.2.0,!=1.3b1,<1.3
|
||||
yasfb>=0.5.1
|
||||
pbr>=2.0.0
|
||||
|
||||
oslosphinx>=4.7.0
|
||||
sphinx>=1.5.1
|
||||
yasfb>=0.6.1
|
||||
|
||||
@ -319,7 +319,7 @@ Share group APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'share_group': {
|
||||
@ -379,7 +379,7 @@ Share group APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'force_delete': None
|
||||
@ -394,7 +394,7 @@ Share group APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'reset_status': '%status%'
|
||||
@ -408,7 +408,7 @@ Share group APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'share_group': {
|
||||
@ -425,7 +425,7 @@ Share group snapshot APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'share_group_snapshot': {
|
||||
@ -473,7 +473,7 @@ Share group snapshot APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'force_delete': None
|
||||
@ -488,7 +488,7 @@ Share group snapshot APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'reset_status': '%status%'
|
||||
@ -502,7 +502,7 @@ Share group snapshot APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'share_group_snapshot': {
|
||||
@ -520,7 +520,7 @@ Share group type APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'share_group_type': {
|
||||
@ -550,7 +550,7 @@ Share group type APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'group_specs': {
|
||||
@ -600,7 +600,7 @@ Share group type access APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'addProjectAccess': {
|
||||
@ -615,7 +615,7 @@ Share group type access APIs:
|
||||
* Method: POST
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'removeProjectAccess': {
|
||||
|
||||
@ -121,7 +121,7 @@ URL: /snapshot-instances/<si-id>/export-locations/<el-id>
|
||||
Driver impact
|
||||
-------------
|
||||
|
||||
Add driver interfaces:
|
||||
Add driver interfaces::
|
||||
|
||||
def snapshot_allow_access(self, context, snapshot, access,
|
||||
share_server=None):
|
||||
|
||||
@ -1 +0,0 @@
|
||||
Add Pike release specs in this folder.
|
||||
@ -75,7 +75,7 @@ boolean value.
|
||||
* Method: PUT
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'quotas': {
|
||||
|
||||
@ -237,4 +237,4 @@ References
|
||||
|
||||
[1] http://eavesdrop.openstack.org/meetings/manila/2016/manila.2016-08-25-15.00.log.html
|
||||
[2] https://tools.ietf.org/html/rfc5952#section-4
|
||||
[3] http://docs.openstack.org/developer/manila/devref/share_back_ends_feature_support_mapping.html
|
||||
[3] http://docs.openstack.org/developer/manila/devref/share_back_ends_feature_support_mapping.html
|
||||
|
||||
@ -4,9 +4,9 @@
|
||||
|
||||
http://creativecommons.org/licenses/by/3.0/legalcode
|
||||
|
||||
====================================================
|
||||
=====================================================
|
||||
Support retrieving shares filtered by export-location
|
||||
====================================================
|
||||
=====================================================
|
||||
|
||||
https://blueprints.launchpad.net/manila/+spec/support-filter-share-by-export-location
|
||||
|
||||
@ -88,8 +88,8 @@ Manila client will add a new parameter '--export_location <export-location>'
|
||||
to command 'list', the modified version of command will be like::
|
||||
|
||||
* list --export_location <export-location> <other existing command arguments>
|
||||
* share-instance-list --export_location <export-location>
|
||||
<other existing command arguments>
|
||||
* share-instance-list --export_location <export-location> <other existing command arguments>
|
||||
|
||||
|
||||
Security impact
|
||||
---------------
|
||||
|
||||
@ -163,7 +163,7 @@ Old microversions will behave as did before.
|
||||
* Method: PUT
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
'quotas': {
|
||||
|
||||
@ -155,9 +155,12 @@ message_map = {
|
||||
MessageIds.UNEXPECTED_NETWORK: _("Current back end configuration does not "
|
||||
"support creating shares within project "
|
||||
"defined share-networks."),
|
||||
|
||||
MessageIds.QUOTA_UPDATE: _("Failed to update quota.")
|
||||
|
||||
}
|
||||
|
||||
|
||||
REST API impact
|
||||
---------------
|
||||
|
||||
@ -178,7 +181,7 @@ Message APIs:
|
||||
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
"messages": [
|
||||
@ -204,7 +207,7 @@ Message APIs:
|
||||
* Method: GET (200, 403 Forbidden, 404 Not Found)
|
||||
* JSON body:
|
||||
|
||||
.. code-block:: json
|
||||
.. code:: json
|
||||
|
||||
{
|
||||
"message": {
|
||||
|
||||
@ -44,8 +44,7 @@ Some notes about using this template:
|
||||
as changing parameters which can be returned or accepted, or even
|
||||
the semantics of what happens when a client calls into the API, then
|
||||
you should add the APIImpact flag to the commit message. Specifications with
|
||||
the APIImpact flag can be found with the following query::
|
||||
|
||||
the APIImpact flag can be found with the following query:
|
||||
https://review.openstack.org/#/q/status:open+project:openstack/manila-specs+message:apiimpact,n,z
|
||||
|
||||
|
||||
|
||||
@ -0,0 +1,2 @@
|
||||
doc8 # Apache-2.0
|
||||
|
||||
12
tox.ini
12
tox.ini
@ -1,6 +1,6 @@
|
||||
[tox]
|
||||
minversion = 1.6
|
||||
envlist = docs,py27
|
||||
minversion = 2.0
|
||||
envlist = docs,py35,py27
|
||||
skipsdist = True
|
||||
|
||||
[testenv]
|
||||
@ -10,13 +10,19 @@ setenv =
|
||||
VIRTUAL_ENV={envdir}
|
||||
deps = -r{toxinidir}/requirements.txt
|
||||
-r{toxinidir}/test-requirements.txt
|
||||
whitelist_externals = echo
|
||||
commands = echo 'None of tests exist. It is placeholder.'
|
||||
|
||||
[testenv:venv]
|
||||
commands = {posargs}
|
||||
|
||||
[testenv:docs]
|
||||
commands = python setup.py build_sphinx
|
||||
whitelist_externals = rm
|
||||
commands =
|
||||
rm -rf doc/build
|
||||
python setup.py build_sphinx
|
||||
# Ignore D001 since we allow lines in excess of 79 characters.
|
||||
doc8 --ignore D001 --ignore-path .tox --ignore-path .eggs --ignore-path doc/build --ignore-path manila_specs.egg-info -e txt -e rst
|
||||
|
||||
[testenv:spelling]
|
||||
deps =
|
||||
|
||||
Loading…
Reference in New Issue
Block a user