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
This commit is contained in:
parent
ac2de165a9
commit
97fa406ef4
2
.gitignore
vendored
2
.gitignore
vendored
@ -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
|
||||
|
@ -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 = ()
|
||||
|
11
doc/source/configuration/index.rst
Normal file
11
doc/source/configuration/index.rst
Normal file
@ -0,0 +1,11 @@
|
||||
=============
|
||||
Configuration
|
||||
=============
|
||||
|
||||
Zaqar UI has no configuration option.
|
||||
|
||||
For more configurations, see
|
||||
`Configuration Guide
|
||||
<https://docs.openstack.org/horizon/latest/configuration/index.html>`__
|
||||
in the Horizon documentation.
|
||||
|
9
doc/source/contributor/api.rst
Normal file
9
doc/source/contributor/api.rst
Normal file
@ -0,0 +1,9 @@
|
||||
=====================
|
||||
Source Code Reference
|
||||
=====================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
:glob:
|
||||
|
||||
api/*
|
17
doc/source/contributor/index.rst
Normal file
17
doc/source/contributor/index.rst
Normal file
@ -0,0 +1,17 @@
|
||||
=================
|
||||
Contributor Guide
|
||||
=================
|
||||
|
||||
There is no topic specific to Zaqar UI now.
|
||||
|
||||
See `Horizon Contributor Documentation
|
||||
<https://docs.openstack.org/horizon/latest/contributor/index.html>`__
|
||||
for general topic on developing a dashboard on horizon.
|
||||
|
||||
----
|
||||
|
||||
.. toctree::
|
||||
:glob:
|
||||
:maxdepth: 1
|
||||
|
||||
api
|
@ -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 <https://docs.openstack.org/releasenotes/zaqar-ui>
|
||||
|
||||
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
|
||||
|
Loading…
Reference in New Issue
Block a user