openstack/horizon
Code Issues Proposed changes
OpenStack Dashboard (Horizon)
12,864 Commits 10 Branches 54 Tags 315 MiB
Python 63.1%
JavaScript 28.8%
HTML 6.5%
SCSS 1.5%
baa9b9c732
Go to file
Doug Hellmann baa9b9c732 use openstackdocstheme html context 
Set some of the new config values and enable openstackdocstheme as an
extension so it will inject values into the page context as it writes
each documentation page. This ensures the pages link to the right bug
tracker, etc.

Change-Id: I36d400358b1b5e2c2423c43f43c775bafb0d4721
Depends-On: Icf3a40ed104cfd828f532f6f2b112ed02f996ff5
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-06-28 19:51:10 +09:00
doc use openstackdocstheme html context 2017-06-28 19:51:10 +09:00
horizon operation_log: Add ignored_urls parameter 2017-06-26 11:07:17 +02:00
openstack_dashboard operation_log: Add ignored_urls parameter 2017-06-26 11:07:17 +02:00
releasenotes use openstackdocstheme html context 2017-06-28 19:51:10 +09:00
tools hacking: noqa cleanup in horizon 2017-03-17 19:38:47 +00:00
.eslintignore bump eslint version to 1.10.3 2016-03-31 14:06:45 +00:00
.eslintrc Disabling warnings of 'quote-props' 2016-05-18 15:04:00 -06:00
.gitignore Generate unit test HTML reports 2017-05-04 07:23:40 +00:00
.gitreview Add .gitreview and rfc.sh. 2011-10-28 09:50:35 -04:00
.mailmap Update my mailmap 2013-10-25 14:49:23 +08:00
.pylintrc updating run_tests.sh to mimic other openstack projects, pep8, pylint, coverage 2011-08-31 14:41:36 -07:00
.testr.conf Add testr support 2015-12-10 09:45:41 +01:00
babel-django.cfg Added a django extract for .csv files 2015-09-15 21:57:42 +00:00
babel-djangojs.cfg Angular translation via babel (singular only) 2015-07-02 11:13:45 +10:00
CONTRIBUTING.rst Workflow documentation is now in infra-manual 2014-12-05 03:30:36 +00:00
HACKING.rst Eliminate mutable default arguments 2015-12-17 09:58:46 +00:00
LICENSE Initial commit 2011-01-12 13:43:31 -08:00
Makefile Remove non-existent "test" target from Make help 2017-03-13 14:35:31 +00:00
manage.py hacking: noqa cleanup in horizon 2017-03-17 19:38:47 +00:00
MANIFEST.in Update MANIFEST for SCSS 2015-09-09 14:42:10 +01:00
package.json Refactor tox & update docs 2016-11-30 20:38:59 +00:00
README.rst Merge "Update and merge the install / deployment docs" 2017-06-15 13:28:48 +00:00
requirements.txt Updated from global requirements 2017-06-15 18:00:55 +00:00
run_tests.sh Add constraints support to run_tests.sh 2016-11-28 11:06:07 +11:00
setup.cfg Enable warning-on-error in Sphinx 1.5 2017-03-27 05:34:52 +09:00
setup.py Updated from global requirements 2017-05-30 13:34:43 +00:00
test-requirements.txt Updated from global requirements 2017-06-27 17:43:20 +00:00
test-shim.js Add Apache 2.0 license to source file 2016-12-02 17:40:28 +07:00
tox.ini Fix H405 (multi line docstring) warnings (openstack_dashboard) 2017-06-09 16:05:31 +00:00

README.rst

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.

image

Using Horizon

See doc/source/install/index.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/install/index.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

To build the docs, use:

$ tox -e docs

Results are in the doc/build/html directory