Remove version numbers everywhere, since we do not branch anymore,
there's no need for a version number.
Change-Id: I244798870caaaa3e47e958cb3a70af9aa320d734
Remove watermark for pike. This allows to remove sphinxmark extension
usage, so remove it and pillow from test-requirements and update
contributor-guide for this.
Explain that guide handles Pike release now.
Change-Id: Ib1c71971b822cc0aa3e6531b2d5607714551d9db
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
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
Because the spec document has changed not to use rst2pdf, remove
a related comment line in conf.py
Depends-On: I773def424637157ae03e6ada51a905880c0e3bf1
Change-Id: Ic9502684d0db2b6ced0a1808600baafb11206809
Implements: blueprint build-pdf-from-rst-guides
stable/newton branch is created, let's set up building properly:
* Do not copy content anymore to /newton.
* The draft guides are now Ocata, change watermark.
Change-Id: I47c54a027481f4a708e5f1cefaff1157040bc155
Adds a Newton watermark to the Install Guides,
Networking Guide, and Config Ref Guide.
Change-Id: I0e4f2942b87d996e9f2fd419f808578636d07e78
Backport: mitaka liberty
Partial-bug: #1479166
- manila content has been moved to the project-specific install-guide.
- Add link to the shared-file-systems installation tutorial
published from within the manila project code tree
Change-Id: Ie541df1d38706bc0c0603b94bffaf06a9316b1c2
Partially-Implements: blueprint projectspecificinstallguides
Partially-Implements: blueprint manila-in-tree-install-guide
Part of "consistency-file-rename" spec [1]
This commit also changes the following:
* Update corresponding references to common in various guides
* Rename excluded_patterns in conf.py of various guide
* Rename existing entries in www/static/.htaccess
* Add entries to .htaccess to redirect renamed files
[1] http://specs.openstack.org/openstack/docs-specs/specs/newton/consistency-file-rename.html
Change-Id: I39a9d5b95535cad1918ee64e95dee5ef18ab2cbe
The install guide currently does not include trove.
This commit provides instructions for how to install
trove.
Change-Id: Ib0fcba5e5a88e1ff3fd4b7138895dc1faf81af36
Implements: bp installguide-add-trove
This file is now only used by user-guide, so remove it from common
directory and remove exclude rule for it.
Also move some figures that are used by the file.
Change-Id: Ifc0efd80f84dcbde5c7adda7ea4769eb08da6411
It is an effort to document manila install guide.
Only Ubuntu distro has been properly updated until now.
Liberty packages have been used for the tests, but it can be
changed to mitaka as soon as they are available. Thanks in
advance for any feedback about this initial effort.
Change-Id: I686bdda2ee27de4e5c43bb8d95c0126c8c300558
Implements: blueprint create-manila-install-guide
We have two index files for Debian and other distributions.
On the other hand, when the tool generates translation resources,
uses only one index file, Debian index as of now.
Therefore, translation for index files is applied
to only one index file.
For example, Translation for Ubuntu index file
are not applied for Ubuntu Installation Guide.
* Unify index files into one file
* Process toctree for each distribution dynamically
Change-Id: I3abcd7da3569bb8e9edbc02574dcb74c12752ede
Closes-Bug: #1507861
We do not need to copy source files anymore with current
openstackdocstheme, unset html_show_sourcelink and html_copy_source
links. Report a bug works without these as well.
This reduces the amount of files we build and publish (for Install Guide
from 42 MB to 39 MB), and thus speeds up building (from 44 to 41s for
Install Guide) slightly.
Change-Id: Id3bc5ea168ed764f67d7a19fac8ad546f2f8eff8
Require new version and cleanup conf.py, we do no need pwd variable
anymore.
Update pbr and hacking requirement - syncing with global requirements.
Change-Id: I53a222445967092e08a1b598a19e8bbe71e378a6
The "Default configuration files vary by distribution." note is
duplicated in a lot of files. This patch moves this note into a separate
file and includes this file in all files using this note.
Change-Id: Ie61e378a217539259180f2e56282b137dd8aa30a
We cannot use ..only.. with a toctree, it gets parsed at the wrong
time.
Add a second Debian specific index file so that Debian gets only this
file. This avoids the double index entry in the sidetable but leads to
no index table for Debian.
Change-Id: I6f4e7dffb2c5cd4416607817dcb3685b65b0674d
Partial-Fix: #1488187
Remove DocBook XML files and rename directory from install-guide-rst to
install-guide.
Adjust everything so that publishing works.
Update README to remove DocBook XML Install Guide specific instructions.
Implements: blueprint installguide-liberty
Change-Id: If723c44c3c0383dc8ab8e53798d82e7f0ee2cc57
