| Age | Commit message (Collapse) | Author | Files | Lines |
|
Change-Id: I2796a9378ef99f0145fe95c4ecff9fd0b5a42894
|
|
Part of changes discussed during Kolla Kalls.
These make our documentation easier to digest.
Changes in conf.py are to avoid warnings from sphinx.
Change-Id: I76ab6786b271963252278fcf12f1a28cab520fdb
|
|
Change-Id: I616ab0d81b961effaa3b4a8639b1d06327473f08
Implements: blueprint remove-unicode
|
|
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
Update Sphinx version as well.
Remove docs requirements from lower-constraints, they are not needed
during install or test but only for docs building.
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.
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-Id: I138d51ace230a434e76fbe9fbbe97e53212230f3
|
|
New theme of docs (Victoria+) respects pygments_style.
Since Kolla starts using Victoria reqs while being on Ussuri,
this patch ensures proper rendering both in Ussuri and Victoria.
Thanks @AJaeger for suggestion.
Change-Id: I6059fff6278ffa0648e241bc15bc8644c493857c
|
|
Change-Id: I6e791016ffa8ab9f2cebccb57f9a5cb5d3b41456
|
|
The is one of community goals that each project should 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: Ia0f8b73bcbda6295319f5c8de1aa02a40844207b
|
|
This ensures we have version-specific references to other projects [1].
Note that this doesn't mean the URLs are actually valid - we need to do
more work (linkcheck?) here, but it's an improvement nonetheless.
[1] https://docs.openstack.org/openstackdocstheme/latest/#external-link-helper
Change-Id: I7c979dacd89ebead404b751d596ba120b38f00f3
|
|
For more detail, see the doc migration spec.
http://specs.openstack.org/openstack/docs-specs/specs/pike/os-manuals-migration.html
Partially-Implements: blueprint queens-doc-restructure
Co-Authored-By: Kurt Taylor <kurt.r.taylor@gmail.com>
Change-Id: Iab93bf023a13b953a31152b91d4fea0fa75bf2d0
|