f8658d9880
Switch to openstackdocstheme 2.2.0 and reno 3.1.0 versions. Using these versions will allow especially: * Linking from HTML to PDF document * parallelizing building of documents Update Sphinx version as well. openstackdocstheme renames some variables, so follow the renames. A couple of variables are also not needed anymore, remove them. Set openstackdocs_pdf_link to link to PDF file. Remove docs requirements from lower-constraints, they are not installed. For more info. please refer [1]. [1] https://review.opendev.org/728938 Change-Id: I90d064e63baa5f067f38a881eb9a556dfb435e97 |
||
|---|---|---|
| doc | ||
| horizon | ||
| openstack_auth | ||
| openstack_dashboard | ||
| playbooks | ||
| releasenotes | ||
| roles | ||
| tools | ||
| .eslintignore | ||
| .eslintrc | ||
| .gitignore | ||
| .gitreview | ||
| .mailmap | ||
| .pylintrc | ||
| .zuul.yaml | ||
| CONTRIBUTING.rst | ||
| HACKING.rst | ||
| LICENSE | ||
| MANIFEST.in | ||
| README.rst | ||
| babel-django.cfg | ||
| babel-djangojs.cfg | ||
| bindep.txt | ||
| lower-constraints.txt | ||
| manage.py | ||
| package.json | ||
| plugin-registry.csv | ||
| reno.yaml | ||
| requirements.txt | ||
| setup.cfg | ||
| setup.py | ||
| test-requirements.txt | ||
| test-shim.js | ||
| tox.ini | ||
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.
- Project documentation: https://docs.openstack.org/horizon/latest/
- Release management: https://launchpad.net/horizon
- Blueprints and feature specifications: https://blueprints.launchpad.net/horizon
- Issue tracking: https://bugs.launchpad.net/horizon
- Release notes: https://docs.openstack.org/releasenotes/horizon/
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 Installation Guide.
Getting Started for Developers
doc/source/quickstart.rst or Quickstart
Guide 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 docsResults are in the doc/build/html directory