From dc3a3978cfeff72f71f3977fce39d77299e08428 Mon Sep 17 00:00:00 2001 From: Andreas Jaeger Date: Mon, 24 Aug 2015 20:09:04 +0200 Subject: [PATCH] Fix double index entry We cannot use ..only.. with a toctree, it gets parsed at the wrong time. Add a second Debian specific index file so that Debian gets only this file. This avoids the double index entry in the sidetable but leads to no index table for Debian. Change-Id: I6f4e7dffb2c5cd4416607817dcb3685b65b0674d Partial-Fix: #1488187 --- doc/install-guide/source/conf.py | 9 +++ .../source/debconf/debconf-api-endpoints.rst | 2 + .../source/debconf/debconf-concepts.rst | 2 + .../debconf/debconf-dbconfig-common.rst | 2 + .../debconf/debconf-keystone-authtoken.rst | 2 + .../source/debconf/debconf-rabbitmq.rst | 2 + doc/install-guide/source/debconf/debconf.rst | 2 + doc/install-guide/source/index-debian.rst | 74 +++++++++++++++++++ doc/install-guide/source/index.rst | 59 +++++---------- 9 files changed, 112 insertions(+), 42 deletions(-) create mode 100644 doc/install-guide/source/index-debian.rst diff --git a/doc/install-guide/source/conf.py b/doc/install-guide/source/conf.py index 898bcfc9ac..56321cc50e 100644 --- a/doc/install-guide/source/conf.py +++ b/doc/install-guide/source/conf.py @@ -53,6 +53,11 @@ source_suffix = '.rst' # The master toctree document. master_doc = 'index' +# We need to use noqa here since tags is defined externally. +if tags.has('debian'): # noqa + master_doc = 'index-debian' +else: + master_doc = 'index' # General information about the project. project = u'Installation Guide' @@ -91,6 +96,10 @@ html_context = {"pwd": pwd, "gitsha": gitsha, "bug_tag": bug_tag} # directories to ignore when looking for source files. exclude_patterns = ['common/cli*', 'common/nova*', 'common/log_in_dashboard.rst'] +if tags.has('debian'): # noqa + exclude_patterns.append('index.rst') +else: + exclude_patterns.append('index-debian.rst') # The reST default role (used for this markup: `text`) to use for all # documents. diff --git a/doc/install-guide/source/debconf/debconf-api-endpoints.rst b/doc/install-guide/source/debconf/debconf-api-endpoints.rst index 6e8b7da17a..3bb2c45f89 100644 --- a/doc/install-guide/source/debconf/debconf-api-endpoints.rst +++ b/doc/install-guide/source/debconf/debconf-api-endpoints.rst @@ -1,3 +1,5 @@ +:orphan: + ====================== Register API endpoints ====================== diff --git a/doc/install-guide/source/debconf/debconf-concepts.rst b/doc/install-guide/source/debconf/debconf-concepts.rst index 4c0a2739d8..1e8ceecf61 100644 --- a/doc/install-guide/source/debconf/debconf-concepts.rst +++ b/doc/install-guide/source/debconf/debconf-concepts.rst @@ -1,3 +1,5 @@ +:orphan: + ================ debconf concepts ================ diff --git a/doc/install-guide/source/debconf/debconf-dbconfig-common.rst b/doc/install-guide/source/debconf/debconf-dbconfig-common.rst index 2f424976cb..153fdd14a4 100644 --- a/doc/install-guide/source/debconf/debconf-dbconfig-common.rst +++ b/doc/install-guide/source/debconf/debconf-dbconfig-common.rst @@ -1,3 +1,5 @@ +:orphan: + =========================================== Configure the database with dbconfig-common =========================================== diff --git a/doc/install-guide/source/debconf/debconf-keystone-authtoken.rst b/doc/install-guide/source/debconf/debconf-keystone-authtoken.rst index 5e62180ee6..c3dd31c9f5 100644 --- a/doc/install-guide/source/debconf/debconf-keystone-authtoken.rst +++ b/doc/install-guide/source/debconf/debconf-keystone-authtoken.rst @@ -1,3 +1,5 @@ +:orphan: + ====================================== Services and the [keystone_authtoken] ====================================== diff --git a/doc/install-guide/source/debconf/debconf-rabbitmq.rst b/doc/install-guide/source/debconf/debconf-rabbitmq.rst index 09207a1242..aaee7c1f9d 100644 --- a/doc/install-guide/source/debconf/debconf-rabbitmq.rst +++ b/doc/install-guide/source/debconf/debconf-rabbitmq.rst @@ -1,3 +1,5 @@ +:orphan: + =============================== RabbitMQ credentials parameters =============================== diff --git a/doc/install-guide/source/debconf/debconf.rst b/doc/install-guide/source/debconf/debconf.rst index 693496b7f9..53a39836e1 100644 --- a/doc/install-guide/source/debconf/debconf.rst +++ b/doc/install-guide/source/debconf/debconf.rst @@ -1,3 +1,5 @@ +:orphan: + ================================ Configure OpenStack with debconf ================================ diff --git a/doc/install-guide/source/index-debian.rst b/doc/install-guide/source/index-debian.rst new file mode 100644 index 0000000000..c269635b90 --- /dev/null +++ b/doc/install-guide/source/index-debian.rst @@ -0,0 +1,74 @@ +======================================= +OpenStack Installation Guide for Debian +======================================= + + +Abstract +~~~~~~~~ + +The OpenStack system consists of several key projects that you install +separately. These projects work together depending on your cloud +needs. These projects include Compute, Identity Service, Networking, +Image Service, Block Storage, Object Storage, Telemetry, +Orchestration, and Database. You can install any of these projects +separately and configure them stand-alone or as connected entities. + +.. only:: rdo + + This guide shows you how to install OpenStack by using packages + available through Fedora 21 as well as on Red Hat Enterprise Linux + 7 and its derivatives through the EPEL repository. + +.. only:: ubuntu + + This guide walks through an installation by using packages + available through Ubuntu 14.04. + +.. only:: obs + + This guide shows you how to install OpenStack by using packages on + openSUSE 13.2 and SUSE Linux Enterprise Server 12 through the Open + Build Service Cloud repository. + +.. only:: debian + + This guide walks through an installation by using packages + available through Debian 8 (code name: Jessie). + +Explanations of configuration options and sample configuration files +are included. + +This guide documents OpenStack Liberty release. + +.. warning:: This guide is a work-in-progress and changing rapidly + while we continue to test and enhance the guidance. Please note + where there are open "to do" items and help where you are able. + +Contents +~~~~~~~~ + +.. toctree:: + :maxdepth: 2 + + overview.rst + basic_environment.rst + debconf/debconf.rst + keystone.rst + glance.rst + nova.rst + networking.rst + horizon.rst + cinder.rst + swift.rst + heat.rst + ceilometer.rst + launch-instance.rst + app_reserved_uids.rst + + common/app_support.rst + common/glossary.rst + +Search in this guide +~~~~~~~~~~~~~~~~~~~~ + +* :ref:`search` diff --git a/doc/install-guide/source/index.rst b/doc/install-guide/source/index.rst index a8c4ff63d2..d9b08011f5 100644 --- a/doc/install-guide/source/index.rst +++ b/doc/install-guide/source/index.rst @@ -71,50 +71,25 @@ This guide documents OpenStack Liberty release. Contents ~~~~~~~~ -.. only:: obs or rdo or ubuntu +.. toctree:: + :maxdepth: 2 - .. toctree:: - :maxdepth: 2 + overview.rst + basic_environment.rst + keystone.rst + glance.rst + nova.rst + networking.rst + horizon.rst + cinder.rst + swift.rst + heat.rst + ceilometer.rst + launch-instance.rst + app_reserved_uids.rst - overview.rst - basic_environment.rst - keystone.rst - glance.rst - nova.rst - networking.rst - horizon.rst - cinder.rst - swift.rst - heat.rst - ceilometer.rst - launch-instance.rst - app_reserved_uids.rst - - common/app_support.rst - common/glossary.rst - -.. only:: debian - - .. toctree:: - :maxdepth: 2 - - overview.rst - basic_environment.rst - debconf/debconf.rst - keystone.rst - glance.rst - nova.rst - networking.rst - horizon.rst - cinder.rst - swift.rst - heat.rst - ceilometer.rst - launch-instance.rst - app_reserved_uids.rst - - common/app_support.rst - common/glossary.rst + common/app_support.rst + common/glossary.rst Search in this guide ~~~~~~~~~~~~~~~~~~~~