Commit Graph

19 Commits

Author SHA1 Message Date
Hervé Beraud be5b93831f Remove unnecessary unicode prefixes
Change-Id: Ibc10c61ee39731501867196ac6fa95b9d6d6c91d
2022-04-20 13:16:50 +02:00
Mark Powers 96b3921d77 Add documentation for configuring availability calendar
This adds documentation explaining how to enable, configure the
calendar attribute, and what permissions are needed to use the
calendar.

Change-Id: I80026407ab537b7967ccbd2965d66f40018c4c0e
2022-01-31 10:03:46 -06:00
Andreas Jaeger d249b802be Switch to newer openstackdocstheme and reno versions
Switch to openstackdocstheme 2.2.1 and reno 3.1.0 versions. Using
these versions will allow especially:
* Linking from HTML to PDF document
* Allow parallel building of documents
* Fix some rendering problems

Update Sphinx version as well.

Set openstackdocs_pdf_link to link to PDF file. Note that
the link to the published document only works on docs.openstack.org
where the PDF file is placed in the top-level html directory. The
site-preview places the PDF in a pdf directory.

Disable openstackdocs_auto_name to use 'project' variable as name.

Change pygments_style to 'native' since old theme version always used
'native' and the theme now respects the setting and using 'sphinx' can
lead to some strange rendering.

openstackdocstheme renames some variables, so follow the renames
before the next release removes them. A couple of variables are also
not needed anymore, remove them.

See also
http://lists.openstack.org/pipermail/openstack-discuss/2020-May/014971.html

Change-Id: I882ab18020ee8a15a3204e72d1bf68f4d5195b14
2020-05-21 20:18:30 +02:00
Andreas Jaeger 26fda6b697 Cleanup py27 support
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Add requires on python >= 3.6 to setup.cfg so that pypi and pip
  know about the requirement
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build
- Cleanup doc/source/conf.py to remove now obsolete content.
- Use newer openstackdocstheme version
- Update hacking to version 3.0; remove hacking and friends
  from requirements, they are not needed; fix warnings found
- Use unittest.mock

Change-Id: I379c086a15477da4b0223fddd48035c829992c88
2020-04-16 15:23:47 +02:00
jacky06 0447828e8f tox: Keeping going with docs
Sphinx 1.8 introduced [1] the '--keep-going' argument which, as its name
suggests, keeps the build running when it encounters non-fatal errors.
This is exceptionally useful in avoiding a continuous edit-build loop
when undertaking large doc reworks where multiple errors may be
introduced.

[1] https://github.com/sphinx-doc/sphinx/commit/e3483e9b045

Change-Id: Ib28727f18d3ff2c86f5dc9ab3dc49bb031650b55
2020-01-20 22:43:05 +01:00
Tetsuro Nakamura 6abf50fdc7 Stop testing with py2
Python 2 is no longer supported. Python 3 is required.
This patch stop testing with python2 and issue the release note.

Change-Id: Idb4c37948b9ad5b19229a86fbbc42c2b63f585eb
2019-12-06 04:14:10 +00:00
manchandavishal 32b1570c4c Generate PDF documentation
Change-Id: I425dfb6d1ef3af313875945392e4d57bdc72be52
Story: 2006073
Task: 34796
2019-09-19 08:58:27 +00:00
jacky06 39e9ba4f2c Update hacking version
Use latest release 1.1.0 and compatible changes w.r.t pep8

Change-Id: I67df079c0a61099f5728a7d9cd7a186ec14b2741
2019-06-03 12:45:59 +00:00
gujin 115585fac0 Sync Sphinx requirement
Sync sphinx dependency with global requirements. It caps python 2 since
sphinx 2.0 no longer supports Python 2.7.

Change-Id: Ib2ba59f4e8d8ca6926ef9bdd501b8b7f1e3e170e
Closes-Bug: #1831377
2019-06-02 23:38:36 +08:00
Le Hou 264a1327c8 Update to opendev
Change-Id: I812238cc25020b2eb333879ae4e3ae4feba14a77
2019-04-23 16:06:58 +08:00
Masahito Muroi 72c8543c91 Add DevStack support to the documentation
The DevStack plugin for Blazar now supports setting up blazar-dashboard
automatically if Horizon is enabled, which is the case by default.

Depends-On: https://review.openstack.org/#/c/580955
Change-Id: I2ef1a8e29b3fa74bf779a990c25df9ec8e312ea4
2018-07-09 18:05:20 +00:00
OpenStack Proposal Bot dbf77a1470 Updated from global requirements
Change-Id: I1ae7a3dd904837704319c0a2794b5845c3a37d62
2018-03-26 11:53:13 +00:00
Hiroaki Kobayashi 0c286007c3 Use OpenStack documentation standards / Nova hypervisor-list API
This patch updates documents for aligning with OpenStack documentation
standards which include using the openstackdocstheme.
This patch also replaces Nova host-list API calls with hypervisor-list
API calls because the former was superseded by the latter [1].

These changes are not related but squashed into one patch for passing
gate tests.

[1] https://docs.openstack.org/releasenotes/python-novaclient/queens.html#id4

Change-Id: I1fe652c17983f2b4505be50d01a26678bf50ef29
Partial-Bug: #1721489
2018-02-13 09:19:21 +00:00
Hiroaki Kobayashi 56bf78dcad Describe new Hosts panel in documentation
Change-Id: Ie01741185b6c9714c7bd035d8f89038f151d7552
Implements: blueprint host-operation-with-dashboard
2017-11-14 09:59:28 +09:00
Hiroaki Kobayashi 6afd13a148 Add a Hosts panel to the admin dashboard
This patch adds a new 'Hosts' panel to the admin dashboard. This panel
is grouped in the 'Reservation' group. Only a list view of hosts is
currently supported.

Partially Implements: blueprint host-operation-with-dashboard

Change-Id: I691fa53de4de1e3fbf367eba2f997cd6cafba875
2017-10-02 19:16:08 +09:00
Jenkins 773393a704 Merge "Support lease creation" 2017-08-18 09:56:56 +00:00
Pierre Riteau 2604e54632 Fix paths to blazar-dashboard configuration files
Because links are relative to the openstack_dashboard/local/enabled
directory, several parent directories need to be traversed.

Change-Id: I0503e7519becae780c32d8d74a48d046d1419799
2017-08-10 09:50:01 +01:00
Hiroaki Kobayashi 6ab330c514 Support lease creation
This patch adds a lease creation feature to the Blazar dashboard.

Change-Id: Id078c570122e3de4d4569023f85a94af7ccaa05b
Partially Implements: blueprint climate-dashboard
2017-08-08 18:00:03 +09:00
Hiroaki Kobayashi c4afe8b438 Add Horizon plugin for Blazar
This patch adds a Horizon plugin for Blazar. The following features are
currently supported:

* Show a list of leases
* Show details of a lease
* Update a lease
* Delete lease(s)

Change-Id: I24c14e697d4280fa29d84d11324fb881009f089b
Partially Implements: blueprint climate-dashboard
Co-Authored-By: Pablo Andres Fuente <pablo.a.fuente@intel.com>
2017-08-03 10:23:54 +00:00