18 Commits

Author SHA1 Message Date
Andreas Jaeger
16a734a0ea 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: Idbe930500bc7988d7e1d78cff3f39beae775db89
2020-05-21 13:47:58 +00:00
Kaifeng Wang
b7000b9623 [Trivial] Doc update on the stable-interface-names
Consistent interface naming is helpful in collecting introspection
data and final instance system.

Change-Id: I8d434f7f8412734a540b797255abb6391325f434
2020-04-20 08:51:39 +08:00
Andreas Jaeger
9fddc46bdc 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
- Remove obsolete sections from setup.cfg
- 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
- Remove install_command from tox.ini, the default is fine
- Update hacking to version 3

Change-Id: I7e9e3993aeb05fb623be531160e418572fa9de54
2020-04-16 18:52:41 +02:00
waleed mousa
075cf46faf Add DIB_REPOREF_requirements when building images using a specific branch
When using a specific branch of ironic-python-agent for building
ironic images, we need to specefiy also the openstack/requirements
branch:

Change-Id: I259b5644150fe78018e2e0a6a4d719b973ab462f
2020-03-29 18:35:45 +00:00
Dmitry Tantsur
3c78c29e94 Replace CentOS 7 images with CentOS 8
CentOS 7 uses Python 2. Although it's possible to install Python 3
on it, it not trivial with DIB. We should rather switch to
a distribution where Python 3 is the default version.

As a nice side effect, the CentOS 8 images seem smaller.

The CentOS 7 job definitions are kept around since they're used
on stable/train.

Change-Id: I6b23da21eab19c69f7b070adff76b35e1752bf8d
2019-12-26 12:37:59 +01:00
Madhuri Kumari
a6c0f2ce63 Fix the binary name in document
Change-Id: Ic64b2129767ae0ef114fddcecbbf574aa1203bf0
2019-12-12 11:35:46 +05:30
Kaifeng Wang
0916598653 Add words on building image for other architecture
Change-Id: I2ca2a574ba84f44dfbfa197d80c14ac0e4c59de2
2019-12-05 10:20:10 +08:00
Zuul
7d975fe286 Merge "DIB: allow disabling rescue mode" 2019-10-16 13:08:19 +00:00
Dmitry Tantsur
cecbc860dd DIB: allow disabling rescue mode
Change-Id: Ife73d59b8e5c4454634d0e6c4f23daaf7cc9fb66
2019-10-09 09:32:04 +00:00
Dmitry Tantsur
ee436f1478 DIB: do not mention dhcp-all-interfaces explicitly
It's a dependency of the ironic-python-agent-ramdisk element, so
it will be included anyway.

Depends-On: https://review.opendev.org/684304
Change-Id: Id47b8ff78506a15045cf31a5f619649a0b3147ed
2019-09-30 20:44:59 +02:00
Dmitry Tantsur
6a07f96f2f Recover iso-image-create script
This script was removed from IPA with CoreOS support, but it seems
to be quite generic. Recover and document it.

Change-Id: I014ada4509e60541bf12ef2bce9915afd8858d54
2019-09-27 09:21:53 +00:00
Dmitry Tantsur
1eee1c17a4 Correct usage of BUILD_AND_INSTALL_TINYIPA
This variable must be executable, so using True won't work. Since
true is the default in finalise-tinyipa, remove the explicit setting
from the role.

Also remove this variable from build-tinyipa since it's not used there
and update the documentation accordingly.

Change-Id: Ibe744121b863ef1265e5e3ead7ab13fef0855fc6
2019-09-25 15:53:20 +02:00
Zuul
70ea14fec5 Merge "Add documentation on building images" 2019-09-24 12:07:41 +00:00
Dmitry Tantsur
d9bc2b6ccc Add documentation on building images
Mostly copy-pasted with small fixes from ironic-python-agent.

Change-Id: I8333a36f343991a888c6e9276ecae03aaf1941ae
2019-09-18 16:00:24 +02:00
Zuul
7e1581bc06 Merge "Build pdf doc" 2019-09-09 14:42:50 +00:00
Kaifeng Wang
cea462b0e4 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: Ic036194e33224be9341dbde901c4ba4717ccbbc8
2019-09-05 14:31:51 +08:00
Dmitry Tantsur
c56bffbefe Make ironic-python-agent-builder packaging-friendly
* Install dib files to /usr/share (tinyipa TBD later)
* Add an executable that can be installed into /usr/bin

Since we now have python code, make pep8 operational.

Change-Id: I9235885485833c4011e42da6db01e150821bd8da
2019-08-12 15:28:34 +02:00
Dmitry Tantsur
77c8f45838 Initial structure
Change-Id: If014272a204953da387855e2666f01d4e9229eaa
2017-11-03 14:34:47 +01:00