From 97fa406ef4abd9bd4bcde6d38b930489e0d1daa3 Mon Sep 17 00:00:00 2001 From: Shu Muto Date: Thu, 13 Jul 2017 15:40:38 +0900 Subject: [PATCH] Rearrange existing documentation to fit the new standard layout This patch changes directory structure for docs. For more detail, see the doc migration spec: http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html Change-Id: Ia434909f37ff75084b8304b3b0ba7fa03903b51f --- .gitignore | 2 +- doc/source/conf.py | 2 +- doc/source/configuration/index.rst | 11 +++++++ doc/source/contributor/api.rst | 9 ++++++ doc/source/contributor/index.rst | 17 ++++++++++ doc/source/index.rst | 31 ++++++++----------- doc/source/{install.rst => install/index.rst} | 0 7 files changed, 52 insertions(+), 20 deletions(-) create mode 100644 doc/source/configuration/index.rst create mode 100644 doc/source/contributor/api.rst create mode 100644 doc/source/contributor/index.rst rename doc/source/{install.rst => install/index.rst} (100%) diff --git a/.gitignore b/.gitignore index 70b3144..95b1db3 100644 --- a/.gitignore +++ b/.gitignore @@ -3,7 +3,7 @@ ChangeLog build cover dist -doc/source/sourcecode +doc/source/contributor/api zaqar_ui/test/.secret_key_store node_modules npm-debug.log diff --git a/doc/source/conf.py b/doc/source/conf.py index 75027c2..8d69dd4 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -71,7 +71,7 @@ def write_autodoc_index(): modlist.append(result) return modlist - RSTDIR = os.path.abspath(os.path.join(BASE_DIR, "sourcecode")) + RSTDIR = os.path.abspath(os.path.join(BASE_DIR, "contributor/api")) SRCS = [('zaqar_ui', ROOT), ] EXCLUDED_MODULES = () diff --git a/doc/source/configuration/index.rst b/doc/source/configuration/index.rst new file mode 100644 index 0000000..c96d950 --- /dev/null +++ b/doc/source/configuration/index.rst @@ -0,0 +1,11 @@ +============= +Configuration +============= + +Zaqar UI has no configuration option. + +For more configurations, see +`Configuration Guide +`__ +in the Horizon documentation. + diff --git a/doc/source/contributor/api.rst b/doc/source/contributor/api.rst new file mode 100644 index 0000000..dd3be26 --- /dev/null +++ b/doc/source/contributor/api.rst @@ -0,0 +1,9 @@ +===================== +Source Code Reference +===================== + +.. toctree:: + :maxdepth: 1 + :glob: + + api/* diff --git a/doc/source/contributor/index.rst b/doc/source/contributor/index.rst new file mode 100644 index 0000000..8c1e232 --- /dev/null +++ b/doc/source/contributor/index.rst @@ -0,0 +1,17 @@ +================= +Contributor Guide +================= + +There is no topic specific to Zaqar UI now. + +See `Horizon Contributor Documentation +`__ +for general topic on developing a dashboard on horizon. + +---- + +.. toctree:: + :glob: + :maxdepth: 1 + + api diff --git a/doc/source/index.rst b/doc/source/index.rst index 4f5d365..ba5e9be 100644 --- a/doc/source/index.rst +++ b/doc/source/index.rst @@ -5,29 +5,24 @@ Zaqar UI Horizon plugin for Zaqar * Free software: Apache license -* Source: http://git.openstack.org/cgit/openstack/zaqar-ui -* Bugs: http://bugs.launchpad.net/zaqar-ui +* Source: https://git.openstack.org/cgit/openstack/zaqar-ui +* Bugs: https://bugs.launchpad.net/zaqar-ui -Usage ------ +User Documentation +------------------ .. toctree:: - :maxdepth: 1 + :maxdepth: 2 - install + install/index + configuration/index + Release Notes -Release Notes -------------- - -* https://docs.openstack.org/releasenotes/zaqar-ui - -Source Code Reference ---------------------- +Contributor Guide +----------------- .. toctree:: - :glob: - :maxdepth: 1 - - sourcecode/autoindex - + :glob: + :maxdepth: 2 + contributor/index diff --git a/doc/source/install.rst b/doc/source/install/index.rst similarity index 100% rename from doc/source/install.rst rename to doc/source/install/index.rst