Cleanup py27 support
Make a few cleanups: - Remove obsolete sections from setup.cfg - Switch to using sphinx-build - Cleanup doc/source/conf.py to remove now obsolete content. - Switch to openstackdocstheme version - Remove install_command from tox.ini, the default is fine - Fix docs warnings Change-Id: Icf6a2d4229392e9d38af67567167b60d02d68019
This commit is contained in:
parent
35efbbe802
commit
63e5a36156
|
@ -27,10 +27,11 @@ import warnings
|
||||||
|
|
||||||
# Add any Sphinx extension module names here, as strings. They can be extensions
|
# Add any Sphinx extension module names here, as strings. They can be extensions
|
||||||
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
|
||||||
extensions = ['sphinx.ext.autodoc',
|
extensions = [
|
||||||
'sphinx.ext.todo',
|
'sphinx.ext.todo',
|
||||||
'sphinx.ext.viewcode',
|
'sphinx.ext.viewcode',
|
||||||
'yasfb',
|
'yasfb',
|
||||||
|
'openstackdocstheme'
|
||||||
]
|
]
|
||||||
|
|
||||||
# Feed configuration for yasfb
|
# Feed configuration for yasfb
|
||||||
|
@ -45,6 +46,12 @@ templates_path = ['_templates']
|
||||||
# The suffix of source filenames.
|
# The suffix of source filenames.
|
||||||
source_suffix = '.rst'
|
source_suffix = '.rst'
|
||||||
|
|
||||||
|
html_theme = 'openstackdocs'
|
||||||
|
repository_name = 'openstack/mistral-specs'
|
||||||
|
bug_project = 'mistral'
|
||||||
|
bug_tag = 'specs'
|
||||||
|
|
||||||
|
|
||||||
# The encoding of source files.
|
# The encoding of source files.
|
||||||
#source_encoding = 'utf-8-sig'
|
#source_encoding = 'utf-8-sig'
|
||||||
|
|
||||||
|
@ -70,6 +77,7 @@ copyright = u'%s, OpenStack Mistral Team' % datetime.date.today().year
|
||||||
exclude_patterns = [
|
exclude_patterns = [
|
||||||
'_build',
|
'_build',
|
||||||
'**/template.rst',
|
'**/template.rst',
|
||||||
|
'**/policy-template.rst'
|
||||||
]
|
]
|
||||||
|
|
||||||
# The reST default role (used for this markup: `text`) to use for all documents.
|
# The reST default role (used for this markup: `text`) to use for all documents.
|
||||||
|
@ -99,7 +107,7 @@ man_pages = []
|
||||||
|
|
||||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||||
# a list of builtin themes.
|
# a list of builtin themes.
|
||||||
html_theme = 'nature'
|
html_theme = 'openstackdocs'
|
||||||
|
|
||||||
# Theme options are theme-specific and customize the look and feel of a theme
|
# Theme options are theme-specific and customize the look and feel of a theme
|
||||||
# further. For a list of options available for each theme, see the
|
# further. For a list of options available for each theme, see the
|
||||||
|
@ -125,17 +133,6 @@ html_theme = 'nature'
|
||||||
# pixels large.
|
# pixels large.
|
||||||
#html_favicon = None
|
#html_favicon = None
|
||||||
|
|
||||||
# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
|
|
||||||
# using the given strftime format.
|
|
||||||
git_cmd = ["git", "log", "--pretty=format:'%ad, commit %h'", "--date=local",
|
|
||||||
"-n1"]
|
|
||||||
try:
|
|
||||||
html_last_updated_fmt = subprocess.check_output(
|
|
||||||
git_cmd).decode('utf-8')
|
|
||||||
except Exception:
|
|
||||||
warnings.warn('Cannot get last updated time from git repository. '
|
|
||||||
'Not setting "html_last_updated_fmt".')
|
|
||||||
|
|
||||||
# If true, SmartyPants will be used to convert quotes and dashes to
|
# If true, SmartyPants will be used to convert quotes and dashes to
|
||||||
# typographically correct entities.
|
# typographically correct entities.
|
||||||
#html_use_smartypants = True
|
#html_use_smartypants = True
|
||||||
|
|
|
@ -13,15 +13,6 @@ a specification has been approved but not completed within one or more
|
||||||
releases since the approval, it may be re-reviewed to make sure it still makes
|
releases since the approval, it may be re-reviewed to make sure it still makes
|
||||||
sense as written. So, a specification may be seen in different groups:
|
sense as written. So, a specification may be seen in different groups:
|
||||||
|
|
||||||
Mitaka
|
|
||||||
------
|
|
||||||
|
|
||||||
.. toctree::
|
|
||||||
:glob:
|
|
||||||
:maxdepth: 1
|
|
||||||
|
|
||||||
specs/mitaka/approved/*
|
|
||||||
|
|
||||||
Newton
|
Newton
|
||||||
------
|
------
|
||||||
|
|
||||||
|
@ -49,6 +40,15 @@ Pike
|
||||||
|
|
||||||
specs/pike/approved/*
|
specs/pike/approved/*
|
||||||
|
|
||||||
|
Rocky
|
||||||
|
-----
|
||||||
|
|
||||||
|
.. toctree::
|
||||||
|
:glob:
|
||||||
|
:maxdepth: 1
|
||||||
|
|
||||||
|
specs/rocky/approved/*
|
||||||
|
|
||||||
Implemented specifications
|
Implemented specifications
|
||||||
==========================
|
==========================
|
||||||
|
|
||||||
|
|
|
@ -1,4 +1,5 @@
|
||||||
pbr!=2.1.0 # Apache-2.0
|
pbr>=2.0,!=2.1.0 # Apache-2.0
|
||||||
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD
|
sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2 # BSD
|
||||||
|
openstackdocstheme>=1.32.0 # Apache-2.0
|
||||||
testtools>=0.9.34
|
testtools>=0.9.34
|
||||||
yasfb
|
yasfb
|
||||||
|
|
14
setup.cfg
14
setup.cfg
|
@ -10,17 +10,3 @@ classifier =
|
||||||
Intended Audience :: Developers
|
Intended Audience :: Developers
|
||||||
License :: OSI Approved :: Apache Software License
|
License :: OSI Approved :: Apache Software License
|
||||||
Operating System :: POSIX :: Linux
|
Operating System :: POSIX :: Linux
|
||||||
|
|
||||||
[build_sphinx]
|
|
||||||
all_files = 1
|
|
||||||
build-dir = doc/build
|
|
||||||
source-dir = doc/source
|
|
||||||
|
|
||||||
[upload_sphinx]
|
|
||||||
upload-dir = doc/build/html
|
|
||||||
|
|
||||||
[pbr]
|
|
||||||
warnerrors = True
|
|
||||||
|
|
||||||
[wheel]
|
|
||||||
universal = 1
|
|
||||||
|
|
|
@ -56,8 +56,8 @@ The following is the data for the PUT request to the execution controller.
|
||||||
.. code-block:: json
|
.. code-block:: json
|
||||||
|
|
||||||
{
|
{
|
||||||
'state': 'RUNNING',
|
"state": "RUNNING",
|
||||||
'params': '{"env": {"k1": "v1"}}'
|
"params": "{'env': {'k1': 'v1'}}"
|
||||||
}
|
}
|
||||||
|
|
||||||
For task re-run, the PUT method of the task controller will be affected.
|
For task re-run, the PUT method of the task controller will be affected.
|
||||||
|
@ -70,7 +70,7 @@ execution and the task execution appropriately.
|
||||||
|
|
||||||
The following is the data for the PUT request to the task controller.
|
The following is the data for the PUT request to the task controller.
|
||||||
|
|
||||||
.. code-block:: json
|
.. code-block:: none
|
||||||
|
|
||||||
{
|
{
|
||||||
'state': 'RUNNING',
|
'state': 'RUNNING',
|
||||||
|
|
|
@ -65,7 +65,7 @@ Alternatives
|
||||||
|
|
||||||
* Start mulitple Mistral instances with different settings.
|
* Start mulitple Mistral instances with different settings.
|
||||||
* This is an inflexible solution for the problem and the setup of the new
|
* This is an inflexible solution for the problem and the setup of the new
|
||||||
instances incurs significant administrative overhead.
|
instances incurs significant administrative overhead.
|
||||||
|
|
||||||
|
|
||||||
Data model impact
|
Data model impact
|
||||||
|
@ -140,22 +140,28 @@ Work Items
|
||||||
* Inject auth URI in execution context
|
* Inject auth URI in execution context
|
||||||
* Reason: Actions require the target Auth URI
|
* Reason: Actions require the target Auth URI
|
||||||
* Tasks:
|
* Tasks:
|
||||||
|
|
||||||
* Set auth_uri in context either from the TARGET_OS_AUTH_URL header or
|
* Set auth_uri in context either from the TARGET_OS_AUTH_URL header or
|
||||||
from CONF.
|
from CONF.
|
||||||
|
|
||||||
* Eliminate admin user for Keystone
|
* Eliminate admin user for Keystone
|
||||||
|
|
||||||
* Reason: Admin credentials should not be required to connect to target
|
* Reason: Admin credentials should not be required to connect to target
|
||||||
cloud.
|
cloud.
|
||||||
* Tasks:
|
* Tasks:
|
||||||
|
|
||||||
* Use non-admin Keystone client
|
* Use non-admin Keystone client
|
||||||
* Use 'tokens' API to retrieve service endpoints
|
* Use 'tokens' API to retrieve service endpoints
|
||||||
|
|
||||||
* Use auth URL from context to create service clients
|
* Use auth URL from context to create service clients
|
||||||
|
|
||||||
* Reason: service clients need to connect to target cloud
|
* Reason: service clients need to connect to target cloud
|
||||||
* Task:
|
* Task:
|
||||||
|
|
||||||
* Do as stated above
|
* Do as stated above
|
||||||
|
|
||||||
* Add new headers to allowed_headers
|
* Add new headers to allowed_headers
|
||||||
|
|
||||||
* Reason: this feature may be used in the future
|
* Reason: this feature may be used in the future
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -26,9 +26,9 @@ Use Cases
|
||||||
---------
|
---------
|
||||||
|
|
||||||
* As a user, I would like to define a workflow with a generic error
|
* As a user, I would like to define a workflow with a generic error
|
||||||
handler task.
|
handler task.
|
||||||
* As a user, I would like to simplify error handling in my complex
|
* As a user, I would like to simplify error handling in my complex
|
||||||
workflow system.
|
workflow system.
|
||||||
|
|
||||||
Proposed change
|
Proposed change
|
||||||
===============
|
===============
|
||||||
|
|
|
@ -80,9 +80,9 @@ with the following keywords:
|
||||||
* 'publish-global' - for global publishing, doesn't exist
|
* 'publish-global' - for global publishing, doesn't exist
|
||||||
* 'publish-global-atomic' - for global atomic publishing, doesn't exist
|
* 'publish-global-atomic' - for global atomic publishing, doesn't exist
|
||||||
* 'publish-global-on-error' - for global publishing in case of error, doesn't
|
* 'publish-global-on-error' - for global publishing in case of error, doesn't
|
||||||
exist
|
exist
|
||||||
* 'publish-global-atomic-on-error' - for global atomic publishing in case of
|
* 'publish-global-atomic-on-error' - for global atomic publishing in case of
|
||||||
error, doesn't exist
|
error, doesn't exist
|
||||||
|
|
||||||
So, we see that a number of keywords is growing and so does the length of the
|
So, we see that a number of keywords is growing and so does the length of the
|
||||||
keywords. This all leads to a non-concise messy syntax.
|
keywords. This all leads to a non-concise messy syntax.
|
||||||
|
|
3
tox.ini
3
tox.ini
|
@ -7,7 +7,6 @@ ignore_basepython_conflict = True
|
||||||
[testenv]
|
[testenv]
|
||||||
basepython = python3
|
basepython = python3
|
||||||
usedevelop = True
|
usedevelop = True
|
||||||
install_command = pip install -U {opts} {packages}
|
|
||||||
setenv =
|
setenv =
|
||||||
VIRTUAL_ENV={envdir}
|
VIRTUAL_ENV={envdir}
|
||||||
deps =
|
deps =
|
||||||
|
@ -24,4 +23,4 @@ commands = {posargs}
|
||||||
[testenv:docs]
|
[testenv:docs]
|
||||||
commands =
|
commands =
|
||||||
find . -type f -name "*.pyc" -delete
|
find . -type f -name "*.pyc" -delete
|
||||||
python setup.py build_sphinx
|
sphinx-build -W -b html doc/source doc/build/html
|
||||||
|
|
Loading…
Reference in New Issue