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_version to not auto-version the documents. 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: I6f7b0e00c112f62dd94a907284fcb3698e84479d
|3 years ago|
|_custom||3 years ago|
|_templates||5 years ago|
|deploy-guide/source||3 years ago|
|doc||3 years ago|
|.gitignore||5 years ago|
|.gitreview||4 years ago|
|.zuul.yaml||3 years ago|
|README.rst||3 years ago|
|bindep.txt||3 years ago|
|requirements.txt||3 years ago|
|setup.cfg||3 years ago|
|setup.py||3 years ago|
|tox.ini||3 years ago|
Team and repository tags
This is the documentation source for the TripleO project. You can read the generated documentation at TripleO Docs.
You can find out more about TripleO at the TripleO Wiki.
Documentation for the TripleO project is hosted on the OpenStack Gerrit site. You can view all open and resolved issues in the
openstack/tripleo-docs project at TripleO Reviews.
General information about contributing to the OpenStack documentation available at OpenStack Documentation Contributor Guide
The following is a quick set of instructions to get you up and running by building the TripleO documentation locally. The first step is to get your Python environment configured. Information on configuring is available at Python Project Guide
Next you can generate the documentation using the following command. Be sure to run all the commands from within the recently checked out repository.
Now you have the documentation generated for the various available formats from the local source. The resulting documentation will be available within the