From cadb9376e48f5628307433588476ae0832e6caff Mon Sep 17 00:00:00 2001 From: Dean Troyer Date: Wed, 24 Oct 2018 14:40:21 -0500 Subject: [PATCH] Remove api-ref directory and jobs This is empty and is being removed from the docs.starlingx.io api-ref landing page. The review to add content here [0] was abandoned, this is cleaning up the empty directory. [0] https://review.openstack.org/#/c/605278/ Change-Id: I35a88672e2c8ef0bc37eb46eba37cd3fbd104a08 Signed-off-by: Dean Troyer --- .zuul.yaml | 3 -- api-ref/source/conf.py | 66 ---------------------------------------- api-ref/source/index.rst | 13 -------- 3 files changed, 82 deletions(-) delete mode 100644 api-ref/source/conf.py delete mode 100644 api-ref/source/index.rst diff --git a/.zuul.yaml b/.zuul.yaml index 5e846714..6a78ea48 100644 --- a/.zuul.yaml +++ b/.zuul.yaml @@ -4,21 +4,18 @@ - build-openstack-docs-pti check: jobs: - - build-openstack-api-ref - build-openstack-releasenotes - openstack-tox-linters - openstack-tox-pep8 - stx-updates-pylint gate: jobs: - - build-openstack-api-ref - build-openstack-releasenotes - openstack-tox-linters - openstack-tox-pep8 - stx-updates-pylint post: jobs: - - publish-stx-api-ref - publish-stx-tox - publish-stx-releasenotes diff --git a/api-ref/source/conf.py b/api-ref/source/conf.py deleted file mode 100644 index ec65486c..00000000 --- a/api-ref/source/conf.py +++ /dev/null @@ -1,66 +0,0 @@ -# -# SPDX-License-Identifier: Apache-2.0 - -# stx-update API reference documentation build configuration file -# -# This file is execfile()d with the current directory set to -# its containing dir. -# -# Note that not all possible configuration values are present in this -# autogenerated file. -# -# All configuration values have a default; values that are commented out -# serve to show the default. - -import os -import sys - -extensions = [ - 'openstackdocstheme', - 'os_api_ref', -] - -html_theme = 'starlingxdocs' - -html_theme_options = { - "sidebar_dropdown": "api_ref", - "sidebar_mode": "toc", -} - -# If extensions (or modules to document with autodoc) are in another directory, -# add these directories to sys.path here. If the directory is relative to the -# documentation root, use os.path.abspath to make it absolute, like shown here. -sys.path.insert(0, os.path.abspath('../../')) -sys.path.insert(0, os.path.abspath('../')) -sys.path.insert(0, os.path.abspath('./')) - -# The suffix of source filenames. -source_suffix = '.rst' - -# The master toctree document. -master_doc = 'index' - -# General information about the project. -repository_name = 'openstack/stx-update' -project = u'stx-update' -bug_project = 'starlingx' -bug_tag = 'stx.update' - -# If true, the current module name will be prepended to all description -# unit titles (such as .. function::). -add_module_names = False - -# If true, sectionauthor and moduleauthor directives will be shown in the -# output. They are ignored by default. -show_authors = False - -# The name of the Pygments (syntax highlighting) style to use. -pygments_style = 'sphinx' - -# Grouping the document tree into LaTeX files. List of tuples -# (source start file, target name, title, author, documentclass -# [howto/manual]). -latex_documents = [ - ('index', 'stx-update.tex', u'stx-update API Documentation', - u'StarlingX', 'manual'), -] diff --git a/api-ref/source/index.rst b/api-ref/source/index.rst deleted file mode 100644 index 3eb6f3b4..00000000 --- a/api-ref/source/index.rst +++ /dev/null @@ -1,13 +0,0 @@ -======================== -stx-update API Reference -======================== - -StarlingX Installation/Update/Patching/Backup/Restore - -.. toctree:: - :maxdepth: 2 - -Search ------- - -:ref:`search`