cc04439da4
warning-on-error option is avaialble in sphinx setup command integration since Sphinx 1.5 [0]. This is useful to prevent future warnings. Note that there is no sphinx error or warning in the current horizon code base :) Also renames 'all_files' to 'all-files' in [build_sphinx] section as this is the actual option name defined in sphinx [0]. The underscore version 'all_files' also works as pbr handles it properly, but we use hyphen version for sphinx options, so the consistent usage is less confusing. [0] https://github.com/sphinx-doc/sphinx/blob/1.5.3/sphinx/setup_command.py#L69 Change-Id: Ic9d1b0e4db30891c694537d43d7f7a51ff92be49
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