From cd67550ef0d596361cdcaf3aa92a4663e65611d9 Mon Sep 17 00:00:00 2001 From: Vieri <15050873171@163.com> Date: Thu, 23 Aug 2018 08:38:22 +0000 Subject: [PATCH] switch documentation job to new PTI This is a mechanically generated patch to switch the documentation jobs to use the new PTI versions of the jobs as part of the python3-first goal. See the python3-first goal document for details: https://governance.openstack.org/tc/goals/stein/python3-first.html Update tox.ini so that tox -e docs works. Remove function exectution from documentation - the function section includes it, this caused a duplicate section. Story: #2002586 Task: #24326 Co-Authored-By: Andreas Jaeger Co-Authored-By: Vieri <15050873171@163.com> Change-Id: I8604aba14b4e9c35e446e53d997f63d12a65e199 --- .zuul.yaml | 4 ++-- doc/source/cli/index.rst | 1 + doc/source/cli/osc/v1/qinling.rst | 7 ------- doc/source/index.rst | 5 ----- tox.ini | 4 +++- 5 files changed, 6 insertions(+), 15 deletions(-) diff --git a/.zuul.yaml b/.zuul.yaml index 7eb8cea..a270af5 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -4,8 +4,8 @@ - openstack-python35-jobs - openstack-python36-jobs - check-requirements - - publish-openstack-sphinx-docs - - release-notes-jobs + - publish-openstack-docs-pti + - release-notes-jobs-python3 - openstackclient-plugin-jobs check: jobs: diff --git a/doc/source/cli/index.rst b/doc/source/cli/index.rst index 063f6b8..f21652d 100644 --- a/doc/source/cli/index.rst +++ b/doc/source/cli/index.rst @@ -1 +1,2 @@ + .. include:: osc/v1/qinling.rst diff --git a/doc/source/cli/osc/v1/qinling.rst b/doc/source/cli/osc/v1/qinling.rst index f2ae55f..e3a8a7e 100644 --- a/doc/source/cli/osc/v1/qinling.rst +++ b/doc/source/cli/osc/v1/qinling.rst @@ -15,13 +15,6 @@ function .. autoprogram-cliff:: openstack.function_engine.v1 :command: function * -================== -function execution -================== - -.. autoprogram-cliff:: openstack.function_engine.v1 - :command: function execution * - === job === diff --git a/doc/source/index.rst b/doc/source/index.rst index c4e0990..ac97483 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -1,8 +1,3 @@ -.. python-qinlingclient documentation master file, created by - sphinx-quickstart on Tue Jul 9 22:26:36 2013. - You can adapt this file completely to your liking, but it should at least - contain the root `toctree` directive. - Python Qinling Client ===================== diff --git a/tox.ini b/tox.ini index 9631742..c79b46f 100644 --- a/tox.ini +++ b/tox.ini @@ -42,9 +42,11 @@ commands = [testenv:docs] basepython = python3 whitelist_externals = rm +deps = -r{toxinidir}/doc/requirements.txt commands = rm -rf doc/build - python setup.py build_sphinx + sphinx-build -E -W -b html doc/source doc/build/html + [testenv:debug] basepython = python3