diff --git a/doc/source/conf.py b/doc/source/conf.py index 9598548..0a72cae 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -27,10 +27,11 @@ import warnings # Add any Sphinx extension module names here, as strings. They can be extensions # coming with Sphinx (named 'sphinx.ext.*') or your custom ones. -extensions = ['sphinx.ext.autodoc', +extensions = [ 'sphinx.ext.todo', 'sphinx.ext.viewcode', 'yasfb', + 'openstackdocstheme' ] # Feed configuration for yasfb @@ -45,6 +46,12 @@ templates_path = ['_templates'] # The suffix of source filenames. source_suffix = '.rst' +html_theme = 'openstackdocs' +repository_name = 'openstack/mistral-specs' +bug_project = 'mistral' +bug_tag = 'specs' + + # The encoding of source files. #source_encoding = 'utf-8-sig' @@ -70,6 +77,7 @@ copyright = u'%s, OpenStack Mistral Team' % datetime.date.today().year exclude_patterns = [ '_build', '**/template.rst', + '**/policy-template.rst' ] # 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 # 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 # further. For a list of options available for each theme, see the @@ -125,17 +133,6 @@ html_theme = 'nature' # pixels large. #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 # typographically correct entities. #html_use_smartypants = True diff --git a/doc/source/index.rst b/doc/source/index.rst index 5750155..ea21a5e 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -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 sense as written. So, a specification may be seen in different groups: -Mitaka ------- - -.. toctree:: - :glob: - :maxdepth: 1 - - specs/mitaka/approved/* - Newton ------ @@ -49,6 +40,15 @@ Pike specs/pike/approved/* +Rocky +----- + +.. toctree:: + :glob: + :maxdepth: 1 + + specs/rocky/approved/* + Implemented specifications ========================== diff --git a/requirements.txt b/requirements.txt index 3e4fa5a..29b584c 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,5 @@ -pbr!=2.1.0 # Apache-2.0 -sphinx!=1.6.6,!=1.6.7,!=2.1.0,>=1.6.2;python_version>='3.4' # BSD +pbr>=2.0,!=2.1.0 # Apache-2.0 +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 -yasfb \ No newline at end of file +yasfb diff --git a/setup.cfg b/setup.cfg index d9709d4..f2ab847 100644 --- a/setup.cfg +++ b/setup.cfg @@ -10,17 +10,3 @@ classifier = Intended Audience :: Developers License :: OSI Approved :: Apache Software License 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 diff --git a/specs/mitaka/implemented/mistral-rerun-update-env.rst b/specs/mitaka/implemented/mistral-rerun-update-env.rst index 737cc53..5217311 100644 --- a/specs/mitaka/implemented/mistral-rerun-update-env.rst +++ b/specs/mitaka/implemented/mistral-rerun-update-env.rst @@ -56,8 +56,8 @@ The following is the data for the PUT request to the execution controller. .. code-block:: json { - 'state': 'RUNNING', - 'params': '{"env": {"k1": "v1"}}' + "state": "RUNNING", + "params": "{'env': {'k1': 'v1'}}" } 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. -.. code-block:: json +.. code-block:: none { 'state': 'RUNNING', diff --git a/specs/newton/implemented/mistral-multi-vim-support.rst b/specs/newton/implemented/mistral-multi-vim-support.rst index 9286670..fce015f 100644 --- a/specs/newton/implemented/mistral-multi-vim-support.rst +++ b/specs/newton/implemented/mistral-multi-vim-support.rst @@ -65,7 +65,7 @@ Alternatives * Start mulitple Mistral instances with different settings. * 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 @@ -140,22 +140,28 @@ Work Items * Inject auth URI in execution context * Reason: Actions require the target Auth URI * Tasks: + * Set auth_uri in context either from the TARGET_OS_AUTH_URL header or from CONF. * Eliminate admin user for Keystone + * Reason: Admin credentials should not be required to connect to target cloud. * Tasks: + * Use non-admin Keystone client * Use 'tokens' API to retrieve service endpoints * Use auth URL from context to create service clients + * Reason: service clients need to connect to target cloud * Task: + * Do as stated above * Add new headers to allowed_headers + * Reason: this feature may be used in the future diff --git a/specs/ocata/implemented/publish-on-failure.rst b/specs/ocata/implemented/publish-on-failure.rst index 262f492..b9365fe 100644 --- a/specs/ocata/implemented/publish-on-failure.rst +++ b/specs/ocata/implemented/publish-on-failure.rst @@ -26,9 +26,9 @@ Use Cases --------- * 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 -workflow system. + workflow system. Proposed change =============== diff --git a/specs/pike/approved/advanced_publishing.rst b/specs/pike/approved/advanced_publishing.rst index ad4abde..a51b982 100644 --- a/specs/pike/approved/advanced_publishing.rst +++ b/specs/pike/approved/advanced_publishing.rst @@ -80,9 +80,9 @@ with the following keywords: * 'publish-global' - for global 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 - exist + exist * '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 keywords. This all leads to a non-concise messy syntax. diff --git a/tox.ini b/tox.ini index b48417a..5064311 100644 --- a/tox.ini +++ b/tox.ini @@ -7,7 +7,6 @@ ignore_basepython_conflict = True [testenv] basepython = python3 usedevelop = True -install_command = pip install -U {opts} {packages} setenv = VIRTUAL_ENV={envdir} deps = @@ -24,4 +23,4 @@ commands = {posargs} [testenv:docs] commands = find . -type f -name "*.pyc" -delete - python setup.py build_sphinx + sphinx-build -W -b html doc/source doc/build/html