15 Commits

Author SHA1 Message Date
Andreas Jaeger
288d663912 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: Iccb449e20174b973f83924659e1ee2db592a326f
2020-05-21 20:35:05 +02:00
Mark Goddard
ced8a4a528 Support linux bridge in addition to OVS
While OVS was used initially due to availability of a
networking-generic-switch driver for it, Linux bridge can be useful for
environments where OVS is not available.

This is configured via bridge_type variable. It defaults to
'openvswitch', but may be set to 'linuxbridge'.

Change-Id: I750a73cebc743edcbcd8c23c67e4920d0058bead
2020-03-13 11:12:37 +00:00
Will Szumski
9c126332be Do not install Open vSwitch
Open vSwitch packages are no longer present in the default, or EPEL
repoistories. This means there is no clean way to install Open vSwitch
on CentOS. Instead, we should leave it up the user to decide how to
install it.

Change-Id: Ie56296230c9840e542ac70d96dc68c285d198ad6
2019-10-21 16:59:06 +01:00
Kaifeng Wang
f92968386b Build pdf doc
The is one of community goals that each project could produce a
single PDF file. The pdf should be in the output of openstack-tox-docs
job.

TeX packages are required to build PDF locally, following is recommended:

* inkscape
* texlive-latex-base
* texlive-latex-extra
* texlive-fonts-recommended

More about the goal:
https://governance.openstack.org/tc/goals/train/pdf-doc-generation.html
https://etherpad.openstack.org/p/train-pdf-support-goal
https://etherpad.openstack.org/p/pdf-goal-train-common-problems

Change-Id: Iae3db530e906e36571951deb31f242b7e4fcb75d
2019-09-05 15:19:40 +08:00
caoyuan
d7142c04d2 Replace git.openstack.org URLs with opendev.org URLs
Change-Id: I8241e8207c5caee7cb9c479bcca6196fedbc7fa3
2019-04-24 14:21:48 +02:00
Zuul
f343264982 Merge "Changes to support standalone ironic" 2018-12-20 15:48:07 +00:00
Mark Goddard
d28635d2cf Changes to support standalone ironic
For standalone ironic deployments, such as those deployed using bifrost, there
is typically no keystone or placement service running. Use of the ironic API is
without authentication. We use clouds.yaml in this case.

Change-Id: I61ed791d019e43f6dfc632fa185f079b385c290c
Story: 2004425
Task: 28077
2018-12-20 09:48:21 +00:00
Mark Goddard
49fb893b83 Changes following becoming an official project
* Updates the documentation to use openstackdocstheme
* Try to make sphinx config more similar to other openstack projects
* Add publishing jobs for docs & release notes
* Update links to source and docs
* Add a version module

Change-Id: I5180e008382e294aa9808a4775e998776f21362a
2018-12-07 18:26:04 +00:00
Will Szumski
4f20ed32f6 Add support for generating release notes
This adds the configuration necessary to build the release notes.
The templates are based off the ones used in Kayobe.

Change-Id: Ia57ac4acaf40cb5e35407fd6e0a5375dbab51522
2018-11-14 09:07:51 +00:00
Will Szumski
a23e2e2d7e Reorder installation steps
Tenks has a dependency on ansible. We need to make sure this is installed
before we run `ansible-galaxy install`. `pip install .` was therefore moved
above `ansible-galaxy install` in the installation steps.
2018-09-26 15:38:26 +01:00
Will Miller
de8e6bcd04 Add boot mode configuration to to-do list 2018-09-21 16:25:40 +01:00
Will Miller
7c46f007ba Add assumptions to install 2018-09-21 16:15:38 +01:00
Will Miller
9e7494a901 Add to-do list to development 2018-09-21 16:15:15 +01:00
Will Miller
36c3756c6c Address doc review comments 2018-09-21 12:25:11 +01:00
Will Miller
0bbca02eec Migrate documentation to Sphinx 2018-09-20 17:24:37 +01:00