From bb63b0815821d7a610edfd3af6b1d29346c674a0 Mon Sep 17 00:00:00 2001 From: Frank Kloeker Date: Sat, 15 Sep 2018 10:52:18 +0200 Subject: [PATCH] Implement documentation changes for translations This is a combined backport of: Move dynamic documentation into extra directory (1/2) https://review.openstack.org/602825 ignore files on translation job https://review.openstack.org/602394 Move dynamic documentation into extra directory (2/2) https://review.openstack.org/602826 Remove non-working dynamic build of AIO scenario table https://review.openstack.org/602953 Change-Id: I129ebbeb40bc5d32ba01701b115437a1f0e9e625 --- .gitignore | 9 ++- doc/source/conf.py | 10 --- doc/source/scenario_table_gen.py | 69 --------------------- doc/source/user/aio/quickstart.rst | 4 -- doc/source/user/aio/scenario-table-gen.html | 1 - 5 files changed, 6 insertions(+), 87 deletions(-) delete mode 100644 doc/source/scenario_table_gen.py delete mode 100644 doc/source/user/aio/scenario-table-gen.html diff --git a/.gitignore b/.gitignore index e21d69a892..83da161dff 100644 --- a/.gitignore +++ b/.gitignore @@ -71,6 +71,9 @@ playbooks/root-include-playbook.yml playbooks/include-playbook.yml* playbooks/logs -# This file is generated by doc/source/scenario_table_gen.py -# So we should ignore any contributor changes to it. -doc/source/user/aio/scenario-table-gen.html +# ignore zanata/sphinx cache on translation job +.zanata-cache/ +doc/source/.doctrees/ + +# ignore fetched upper-contraints file while translation job +upper-constraints.txt diff --git a/doc/source/conf.py b/doc/source/conf.py index bec4cab5e5..0d60a1ec35 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -94,16 +94,6 @@ extlinks = {'deploy_guide': (deploy_guide_prefix, ''), 'dev_docs': (dev_docs_prefix, '') } -# Generate dynamic table file. -SCENARIO_TABLE = 'user/aio/scenario-table-gen.html' -TABLE_FILE = os.path.join(CONF_PATH, SCENARIO_TABLE) -stg = imp.load_source( - 'scenario_table_gen', - os.path.join(CONF_PATH, 'scenario_table_gen.py') -) -with open(TABLE_FILE, 'w') as f: - f.write(stg.main()) - # 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. diff --git a/doc/source/scenario_table_gen.py b/doc/source/scenario_table_gen.py deleted file mode 100644 index 166c21f143..0000000000 --- a/doc/source/scenario_table_gen.py +++ /dev/null @@ -1,69 +0,0 @@ -#!/usr/bin/env python -# Copyright 2017, Rackspace US, Inc. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -import os - -import yaml - - -SCRIPT_PATH = os.path.dirname(os.path.realpath(__file__)) -SCENARIO_FILE = '../../tests/vars/bootstrap-aio-vars.yml' -HTML_TABLE = """""" - - -def main(): - scenario_file = os.path.join(SCRIPT_PATH, SCENARIO_FILE) - with open(scenario_file) as f: - _meta_data = yaml.safe_load(f.read()) - - scenario_meta_data = _meta_data['confd_overrides'] - scenarios = list(sorted(scenario_meta_data.keys())) - scenarios.insert(0, '') - HTML_TABLE = '
' - HTML_TABLE += '' - for s in scenarios: - HTML_TABLE += ''.format(s) - HTML_TABLE += '' - - config_items = set() - for items in scenario_meta_data.values(): - for item in items: - config_items.add(item['name'].split('.')[0]) - config_items = list(sorted(config_items)) - - for item in config_items: - HTML_TABLE += '' - HTML_TABLE += ''.format(item.lower()) - for scenario in scenarios: - try: - scenario_meta = scenario_meta_data[scenario] - except KeyError: - pass - else: - for _items in scenario_meta: - if item == _items['name'].split('.')[0]: - HTML_TABLE += '' - break - else: - HTML_TABLE += '' - HTML_TABLE += '' - HTML_TABLE += '' - HTML_TABLE += '
{}
{}X 
' - - return HTML_TABLE - - -if __name__ == '__main__': - print(main()) diff --git a/doc/source/user/aio/quickstart.rst b/doc/source/user/aio/quickstart.rst index e5b2066a96..df0598dc3a 100644 --- a/doc/source/user/aio/quickstart.rst +++ b/doc/source/user/aio/quickstart.rst @@ -218,10 +218,6 @@ execute the following: **Tested Scenarios** -.. raw:: html - :file: scenario-table-gen.html - - To add OpenStack Services over and above the `bootstrap-aio default services`_ for the applicable scenario, copy the ``conf.d`` files with the ``.aio`` file extension into ``/etc/openstack_deploy`` and rename then to ``.yml`` files. diff --git a/doc/source/user/aio/scenario-table-gen.html b/doc/source/user/aio/scenario-table-gen.html deleted file mode 100644 index 75dbdffc3b..0000000000 --- a/doc/source/user/aio/scenario-table-gen.html +++ /dev/null @@ -1 +0,0 @@ -
aio_basekitaio_lxcaio_metalaio_nspawncephcongressoctaviatackertranslations
ceph    X    
cinderXXXXX   X
congress     X   
designate X X    X
glanceXXXXX X X
haproxyXX XXXXXX
heat XXX   XX
horizon X X    X
keystoneXXXXXXXXX
magnum        X
neutronXXXXXXX X
novaXXXXXXX X
octavia      X X
sahara        X
swift XXX    X
tacker       X 
trove        X
\ No newline at end of file