From e75a036cda6c3bea5f799a1686f35d21e75a6706 Mon Sep 17 00:00:00 2001 From: Akihiro Motoki Date: Tue, 24 Sep 2019 18:04:54 +0900 Subject: [PATCH] doc: Move DevStack local.conf to "Topics" section contributor/ref/ directory contains the module reference and local.conf was the only exception. "Topics" section looks more appropriate place to have a guide to configure DevStack for horizon. Change-Id: Ibfafe7c608753633e0b78765073afa2924602551 --- doc/source/contributor/ref/horizon.rst | 2 +- doc/source/contributor/ref/index.rst | 14 +++++++------- .../{ref/local_conf.rst => topics/devstack.rst} | 9 +++------ doc/source/contributor/topics/index.rst | 1 + 4 files changed, 12 insertions(+), 14 deletions(-) rename doc/source/contributor/{ref/local_conf.rst => topics/devstack.rst} (95%) diff --git a/doc/source/contributor/ref/horizon.rst b/doc/source/contributor/ref/horizon.rst index 067f959118..c688a3352e 100644 --- a/doc/source/contributor/ref/horizon.rst +++ b/doc/source/contributor/ref/horizon.rst @@ -1,5 +1,5 @@ ================== -The horizon Module +The Horizon Module ================== .. module:: horizon diff --git a/doc/source/contributor/ref/index.rst b/doc/source/contributor/ref/index.rst index 10b926150e..e433d031c6 100644 --- a/doc/source/contributor/ref/index.rst +++ b/doc/source/contributor/ref/index.rst @@ -1,8 +1,9 @@ -============= -API Reference -============= +================ +Module Reference +================ -In-depth documentation for Horizon framework and its APIs. +Horizon Framework +----------------- .. toctree:: :maxdepth: 1 @@ -17,10 +18,9 @@ In-depth documentation for Horizon framework and its APIs. decorators exceptions test - local_conf -Auth API Reference -================== +openstack_auth Module +--------------------- .. toctree:: :maxdepth: 2 diff --git a/doc/source/contributor/ref/local_conf.rst b/doc/source/contributor/topics/devstack.rst similarity index 95% rename from doc/source/contributor/ref/local_conf.rst rename to doc/source/contributor/topics/devstack.rst index 23f46afb5f..80ae656768 100644 --- a/doc/source/contributor/ref/local_conf.rst +++ b/doc/source/contributor/topics/devstack.rst @@ -1,11 +1,8 @@ .. _local-conf: -========== -local.conf -========== - -Configuring DevStack for Horizon -================================ +==================== +DevStack for Horizon +==================== Place the following content into ``devstack/local.conf`` to start the services that Horizon supports in DevStack when ``stack.sh`` is run. If you need to use diff --git a/doc/source/contributor/topics/index.rst b/doc/source/contributor/topics/index.rst index 84fb9e598d..6843bcc557 100644 --- a/doc/source/contributor/topics/index.rst +++ b/doc/source/contributor/topics/index.rst @@ -19,3 +19,4 @@ the following topic guides. translation ini-based-configuration packaging + devstack