99920e8a49
Switch our docs job to use opendev-tox-docs job as base so that we can publish later the content from gate directly (via promote queue) and do not need to rebuild in post again. Use the new promote-openstack-manuals job as first step in using promote publishing. The other publish jobs will be replaced separately. Use for building now publishdocs/publishlang so that we have exactly the same content in check and gate - and in the published website. For this, update tox.ini and publish script. Also, do not publish project-data. Depends-On: https://review.opendev.org/676489 Change-Id: I91f22173a4a6ed421f339833c486a31fd319dba3
Team and repository tags
OpenStack Manuals
This repository contains documentation for the OpenStack project.
For more details, see the OpenStack Documentation Contributor Guide.
It includes these manuals:
- Architecture Design Guide
- Documentation Contributor Guide
- High Availability Guide
- Installation Guide
- Virtual Machine Image Guide
In addition to the guides, this repository contains:
- docs.openstack.org contents:
www
Building
Various manuals are in subdirectories of the doc/
directory.
Guides
Some pre-requisites are needed to build the guides. If you are using
a Linux operating system you can generate a report of missing local
requirements with the bindep command:
$ tox -e bindepAll guides are in the RST format. You can use tox to
prepare virtual environment and build all guides (HTML only):
$ tox -e docsYou can also build a specific guide.
For example, to build OpenStack Virtual Machine Image Guide, use the following command:
$ tox -e build -- image-guideYou can find the root of the generated HTML documentation at:
doc/image-guide/build/html/index.htmlTo build a specific guide with a PDF file, add a -pdf
option like:
$ tox -e build -- image-guide --pdfThe generated PDF file will be copied to the root directory of the generated HTML documentation.
PDF builds are accomplished using LaTeX as an intermediate format.
Currently, you can generate a PDF file for a limited number of guides.
The supported list is maintained in the
tools/build-all-rst.sh file.
If you get the error message
make: xelatex: No such file or directory, it means your
local environment does not have LaTeX installed. Read Getting LaTeX and Install
dependencies for building documentation for instructions.
Testing of changes and building of all manuals
Install the Python tox package and run tox from the
top-level directory to use the same tests that are done as part of the
OpenStack CI jobs.
If you like to run individual tests, run:
tox -e checkbuild- to actually build the manual; this also generates a directorypublish-docsthat contains the built files for inspectiontox -e checklang- to build translated manualstox -e linters- to run the niceness tests, for example, to see extra whitespacestox -e linkcheck- to run the tests for working remote URLs
The tox command uses the openstack-doc-tools package to
run the tests.
Generated files
Some documentation files are generated using tools. These files
include a do not edit header and should not be modified by
hand. Please see Generated
files.
Bugs
Bugs should be filed on Launchpad, not GitHub:
https://bugs.launchpad.net/openstack-manuals
Release Notes
https://docs.openstack.org/releasenotes/openstack-manuals
Installing
Refer to https://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.