From f253a48c459e396d3dda4fc7daddbf58d4c93e32 Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Thu, 11 Oct 2018 08:40:19 -0500 Subject: [PATCH] Add api-ref publish job * Add pointers in the main doc to api-ref and releasenotes pages * Add publish-stx-api-ref job * Add search at bottom of api-ref and relnotes pages to trigger the jobs * Add openstackdocstheme installation into requirements file Change-Id: I11db7e584f3e16f1fd0517a5c0059bdc2d448399 Signed-off-by: Abraham Arce --- .zuul.yaml | 1 + api-ref/source/index.rst | 1 + doc/requirements.txt | 1 + doc/source/index.rst | 8 ++++++++ 4 files changed, 11 insertions(+) diff --git a/.zuul.yaml b/.zuul.yaml index 943bedd53..99d7c6202 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -12,4 +12,5 @@ - openstack-tox-linters post: jobs: + - publish-stx-api-ref - publish-stx-docs diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst index 0b9b69b76..cd6f37a4b 100644 --- a/api-ref/source/index.rst +++ b/api-ref/source/index.rst @@ -12,3 +12,4 @@ StarlingX Documentation api-ref-image-v2-cgcs-ext api-ref-networking-v2-cgcs-ext +:ref:`search` diff --git a/doc/requirements.txt b/doc/requirements.txt index c0f770583..f27b52d00 100644 --- a/doc/requirements.txt +++ b/doc/requirements.txt @@ -1,5 +1,6 @@ openstack-doc-tools>=1.6.0 sphinx>=1.6.2 +openstackdocstheme>=1.19.0 # Apache-2.0 # API Reference Guide os-api-ref>=1.4.0 # Apache-2.0 diff --git a/doc/source/index.rst b/doc/source/index.rst index 7f8111173..96f0d98c2 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -33,6 +33,14 @@ Specs Specs +API Reference +------------- + +.. toctree:: + :maxdepth: 1 + + API Reference + Contributing ============