
horizon devref has both explicit autodoc directives and automatically generated source references. This causes a lot of 'WARNING: duplicate object description'. I think that we don't need source code references for most modules and it is better to have explicit API references of modules for which we need references. Thus this commit removes the logic to generate source references. This contributes a lot to reduce the number of sphinx warnings. Also reduces the required time of documentation build :-) Partial-Bug: #1411719 Partial-Bug: #1486222 Change-Id: Iba2bf3723cad159f4cfd1fff47e8114d9867e040
2.8 KiB
Horizon: The OpenStack Dashboard Project
Introduction
Horizon is the canonical implementation of OpenStack's Dashboard, which provides a web based user interface to OpenStack services including Nova, Swift, Keystone, etc.
For a more in-depth look at Horizon and its architecture, see the
Introduction to Horizon <intro>
.
To learn what you need to know to get going, see the quickstart
.
Using Horizon
How to use Horizon in your own projects.
topics/install topics/deployment topics/settings topics/customizing topics/packaging
Developer Docs
For those wishing to develop Horizon itself, or go in-depth with
building your own ~horizon.Dashboard
or ~horizon.Panel
classes, the following documentation
is provided.
General information
Brief guides to areas of interest and importance when developing Horizon.
intro quickstart contributing testing plugin_registry
Tutorials
Detailed tutorials to help you get started.
tutorials/plugin tutorials/dashboard tutorials/table_actions tutorials/workflow_extend
Topic Guides
Information on how to work with specific areas of Horizon can be found in the following topic guides.
topics/workflows topics/tables topics/policy topics/testing topics/angularjs topics/javascript_testing topics/styling topics/translation
API Reference
In-depth documentation for Horizon and its APIs.
ref/run_tests ref/horizon ref/workflows ref/tables ref/tabs ref/forms ref/middleware ref/context_processors ref/decorators ref/exceptions ref/test ref/local_conf
Release Notes
See http://docs.openstack.org/releasenotes/horizon/.
Information
faq glossary
genindex
modindex