The openstackdocstheme requires now setting of bug_project, set it up
everywhere.
Change-Id: I778800b8944e3e1d89cdbd1f844c5830a94012d6
Depends-On: Ifd715d1d46d1b1796d79679c9e954d21e9d09455
With the new openstackdocstheme used, we can simplify conf.py.
Also, update our docs for it.
Note that Sphinx 1.6 needs latexmk for building, add it.
Sphinx 1.6 introduces a few new warnings, fix them so that the guides
built.
Change-Id: If2e431725eb54f8be79b9fa4bf9ede2089f321a5
Update for latest Fedora and CentOS images.
Other updates throughout the guide.
Change-Id: I9cfdf6b75bd3e47a354b3d4095209f7f3c0aaf48
Closes-bug: 1443815
Move glossary and appendix in one chapter called appendix.
This has been done already for arch-design and ops-guide, do it for the
other guides. Share common appendix.
Change-Id: I6bf4e94f6c0569850cca6558be672de298bb208c
This commit applies theme and styling to PDF generation
using xelatex with customized styles.
In openstackdocstheme, style is defined in pdftheme.sty,
and conf.py makes use of the file as LaTeX package.
Also, some rst files are modified to add PDF directives
to adjust better UI in PDFs.
Not all documents are our targets in this commit but feel
free to add more here if anyone wants.
- Current applied styles with openstackdocstheme
: Dedicated title without a blank page
: Put a logo image into suitable place.
: No chapter/section number
: Light gray background for code blocks
: Font definition is in openstackdocstheme not in conf.py
- rst modification
: Table wrap adjustment (".. tabularcolumns::" directive)
: Exclude "Search in this page" section (".. only:: html" directive)
Change-Id: I2782e0a1f0258a6016559b16c8967cc52f48f734
Depends-On: I423675ff79827966e789df70b0f970ac2a10da50
Implements: blueprint build-pdf-from-rst-guides
Co-Authored-By: Ian Y. Choi <ianyrchoi@gmail.com>
Version numbers will be used in PDFs such as
"Release Version: 15.0" following short X.Y version.
Note that Ocata is 15th release.
Change-Id: I6a11992e819626f3b4f4360222521795f7e3b74d
With the change to search.html, the search page now
searches docs.openstack.org, not the specific guide.
Update the header to reflect this.
Change-Id: I9cb4b7669e4c0767e73b105867240a1079d0c086
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.
Remove all-files, we do not have man pages.
Note that the build_sphinx section is not used by our toolchain, still
doesn't harm to use proper setup so that it could be used.
Change-Id: I03403b1ed20c4a4bccb1c03311d3999e12a98416
Add properties to the Windows image example which are best practices:
- Add os-distro
- Add os-version
- Revise os-variant to match other Windows values 8k > 12k
Change-Id: Id829df0a83ac6d32191eb2f13f9873950f7f71a6
Closes-bug: #1663330
After adding some metadatas to one image, all associated properties
should be displayed by the openstack image show command.
Change-Id: I56bcca7d7f4ba296e8cc36e4a22aeb5c7b78c2af
The new sphinx version introduces some changes that break build:
* Warns if code cannot be parsed for highlighting. Fix the code so
that it can be parsed, this includes uncommenting "..." lines.
Note that not every config file is an ini-file.
Also, the parser seems to have bugs and cannot parse all files.
Fix mysql ini file and enable the parameter, see
http://dev.mysql.com/doc/refman/5.7/en/innodb-parameters.html#sysvar_innodb_file_per_table
* :option: works only with declared options, replace useage with
simple ``.
This change only handles a few files, more to come later.
Change-Id: I7c7335e514581622dd562ee355f62d6ae1beaa18
To avoid building error derived from UTF-8 characters,
this patch changed them to ascii characters.
Change-Id: I1905e2646579b7f4b25fef1867b9a9ea12863ef3
Implements: blueprint build-pdf-from-rst-guides
The CentOS custom cloud image example is missing the proper depedency
to grow the root partition and also omits that the root partition
should be the last partition created during disk partitioning.
Change-Id: I9a35393c933472d86a21830ff6077e28fee68745
Andreas Jaeger