OpenStack Dashboard (Horizon)
Go to file
Rob Cresswell 36d1d1ac68 Refactor tox & update docs
- Updated tox envlist, so just running `tox` from the CLI will now run all
voting gate tests

- Reduce duplicated definitions and commands

- Remove any reliance on run_tests within tox

- Removes all doc references to run_tests.sh, and replaces them
with their tox equivalent. Where necessary, language around the tox
commands has been altered or extended so that it makes sense and is
consistent with other parts of the docs. Also adds a new "Test Environment"
list to the docs, so that newcomers do not have to piece together CLI
commands and their cryptic extensions from tox.ini

- Move the inline shell scripting to its own file. Also fixes a bug when
passing args, since the logic assumed you were attempting a subset test
run (try `tox -e py27 -- --pdb` on master to compare)

- Moved translation tooling from run_tests to manage.py, w/ help text
and arg restrictions. This is much more flexible so that plugins can use
it without having to copy commands, but still defaults to exactly the
same parameters/behaviour from run_tests. Docs updated appropriately.

- Removed npm/karma strange reliance on either .venv or tox/py27. Now
it only uses tox/npm.

Change-Id: I883f885bd424955d39ddcfde5ba396a88cfc041e
Implements: blueprint enhance-tox
Closes-Bug: 1638672
2016-11-30 20:38:59 +00:00
doc Refactor tox & update docs 2016-11-30 20:38:59 +00:00
horizon Refactor tox & update docs 2016-11-30 20:38:59 +00:00
openstack_dashboard Refactor tox & update docs 2016-11-30 20:38:59 +00:00
releasenotes Refactor tox & update docs 2016-11-30 20:38:59 +00:00
tools Refactor tox & update docs 2016-11-30 20:38:59 +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 Refactor tox & update docs 2016-11-30 20:38:59 +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
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
MANIFEST.in Update MANIFEST for SCSS 2015-09-09 14:42:10 +01:00
Makefile Unifies the project packaging into one set of modules. 2012-02-29 00:20:13 -08:00
README.rst Add install guide for users and clean up README 2014-10-09 03:29:26 +09: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
manage.py Gate on H102 Apache 2.0 license header not found for pep8 2013-11-19 13:55:04 -05:00
package.json Refactor tox & update docs 2016-11-30 20:38:59 +00:00
requirements.txt ceilometerclient removed from requirements.txt 2016-11-25 14:14:33 +03:00
run_tests.sh Add constraints support to run_tests.sh 2016-11-28 11:06:07 +11:00
setup.cfg Add Python 3.5 classifier 2016-09-06 04:41:48 +00:00
setup.py Updated from global requirements 2015-09-19 05:37:19 +00:00
test-requirements.txt Updated from global requirements 2016-11-02 21:53:34 +00:00
test-shim.js Fix bug where WEBROOT is not respected 2015-07-22 04:10:50 +00:00
tox.ini Refactor tox & update docs 2016-11-30 20:38:59 +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.

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 --docs
  • Building Manually:

    $ tools/with_venv.sh sphinx-build doc/source doc/build/html

Results are in the doc/build/html directory