These excludes were removed from the requirements repo[1] and are now
detected as errors.
[1] 314734e938f107cbd5ebcc7af4d9167c11347406
Change-Id: I7583663228f6050f087628cdb90fdf36b3782760
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.
Set openstackdocs_auto_name to use 'project' 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: I38ad719a8942ec1ae1c78e8d680e467b06815a20
This repo is now testing only with Python 3, so let's make
a few cleanups:
- Remove python 2.7 stanza from setup.py
- Remove obsolete sections from setup.cfg
- Update classifiers
- Update requirements, no need for python_version anymore
- Switch to using sphinx-build
- Use newer openstackdocstheme and Sphinx versions
- Cleanup */source/conf.py to remove now obsolete content.
Change-Id: Icf69fa99ed77a0935062ee4fc8e9c6a195b381e5
This commit adds a new tox target to build PDF documentation.
It's a part of community goal, see storyboard for more
information.
Story: 2006083
Task: 34856
Our cgit instance will be going away and opendev.org is the new
preferred URL for browsing our git repos. Redirects will exist for the
foreseeable future, but it's more efficient to just go directly to the
new locations.
Change-Id: Ia84b464390dbbaaba4c87c4032f5fd21a529f412
Co-Authored-By: Vishal Manchanda <manchandavishal143@gmail.com>
Previously the installation guide seems to target developers.
This commit makes it more generic and add some useful contents.
Change-Id: I75a996e315e3d46c41c66a22f93be70ee5807837
The current top page of heat-dashboard doc is a bit tricky.
The content of installation is duplicated, for example.
This commit revisit the document structure.
* Drop installation instruction from README
* Drop meaningless indices and tables (which are not working)
* Move DevStack setup to the contributor document
* Merge installation_contents.rst into installation.rst
Change-Id: I897cfe0094358db63a364088fd2b977e234101e8
Some deployment methods are using the files delivered by the
installation of packages to configure dashboards.
For example, it's possible to pip install heat-dashboard and
use the use local_settings.d files shipped inside the package
to deploy the heat-dashboard.
When the heat dashboard was not a plugin and included in horizon,
it was usable without having to care about the policy file.
This has changed, as the file is not shipped into horizon by
default, and is not available when pip installing the heat
dashboard directly, unlike the other files (above).
This patch follows the pattern set by murano here [1], to be
able to use the default policy file, shipped with the code,
after a pip install of the heat-dashboard.
[1]: 873fd7ff85/muranodashboard/conf/murano_policy.json
Change-Id: I7e1d74bebc97874c9049f6be33cef27806739b11
To enable translate job correctly, deleted heat-dashboard/locale
directory and updated babel-django.cfg accordingly.
Also fixed tox.ini which included wrong commands for docs build.
Change-Id: Idb7996ded645a8bc8bcb3b7eb08c8754a8492873
Heat relevant contents will be split out
from Horizon in Queens release.
After this splitting out, Heat-Dashboard must have
its own settings in Heat-Dashboard repository.
So this review request includes following.
- Create own settings under local_settings.d
- Add procedure for installing above settings.
- Fix installation procedure according to above changes.
Change-Id: I0b9a9907cb0c02aed70e7c1af3d9d07b0ddeffb6
To slit out Heat support from Horizon, migrate Heat relevant docs from
Horizon repo to Heat Dashboard repo.
Change-Id: Ie0334b8af060a8251a649a49d982086709472190
according to Horizon team's advice.
I've changed installation procedure as follows.
(before changing)
1. copy heat_policy.json from Heat-Dashboard directory
to Horizon directory (same as enable files)
2. add orchestration key to POLICY_FILES settings
(after changing)
1. just point Heat-Dashboard policy file path
from POLICY_FILES settings
Change-Id: Idaf2cbfcb716a9aa4c0f43283526302f062ea0a7
After Heat relevant contents will split out from Horiozon,
I guess 'orchestration' key of POLICY_FILES settings will be
removed also.
So I've add procedure for adding this key
so that user can correctly enable heat_policy.json
Change-Id: I77ae6c6f63f5ae0f21e9aa6d33edca458bb17502
Current installation procedure in README.rst and
doc/source/install/installation_contents.rst does not have
installation process of heat-dashboard itself.
I added above procedure by this review request.
Change-Id: I97f7d114c1f1e978286bd218df558ddf5340d901
In future, Heat relevant files(like GUI, api client, policy files, ...)
will be split out from Horizon repository.
But now this repository does not have Heat policy file so I've copied
it from Horizon latest repository.
This review request also includes following changes.
- Added installation procedure document relates to heat_policy.json.
- Modified plugin.sh to install heat_policy.json.
Change-Id: I8dd386e392eb4467b03efd68c7959371d4b9576d
