215ccba9ec
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
Horizon (OpenStack Dashboard)
Horizon is a Django-based project aimed at providing a complete
OpenStack Dashboard along with an extensible framework for building new
dashboards from reusable components. The
openstack_dashboard module is a reference implementation of
a Django site that uses the horizon app to provide
web-based interactions with the various OpenStack projects.
- Release management: https://launchpad.net/horizon
- Blueprints and feature specifications: https://blueprints.launchpad.net/horizon
- Issue tracking: https://bugs.launchpad.net/horizon
Using Horizon
See doc/source/topics/install.rst about how to install
Horizon in your OpenStack setup. It describes the example steps and has
pointers for more detailed settings and configurations.
It is also available at http://docs.openstack.org/developer/horizon/topics/install.html.
Getting Started for Developers
doc/source/quickstart.rst or http://docs.openstack.org/developer/horizon/quickstart.html
describes how to setup Horizon development environment and start
development.
Building Contributor Documentation
This documentation is written by contributors, for contributors.
The source is maintained in the doc/source directory
using reStructuredText and
built by Sphinx
Building Automatically:
$ ./run_tests.sh --docsBuilding Manually:
$ tools/with_venv.sh sphinx-build doc/source doc/build/html
Results are in the doc/build/html directory