e39304d4ae
The PDF build does not include content multiple times if the same file is included in a toctree more than once. That means we need to restructure the guide to handle the common parts differently. This approach merges some of the previously split sections back together using inline prose to indicate where minor variations apply for different operating systems but retaining separate files for cases where the differences are significant. Change-Id: I5d9ff549b05ca4ce54486719d70858589b8fcfa3 Depends-On: Ia750cb049c0f53a234ea70ce1f2bbbb7a2aa9454 Signed-off-by: Doug Hellmann <doug@doughellmann.com>
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:
- Administrator Guide
- Architecture Design Guide
- Command-Line Interface Reference
- Configuration Reference
- Documentation Contributor Guide
- End User Guide
- High Availability Guide
- Installation Tutorials
- Networking Guide
- Operations 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 docs
You can also build a specific guide.
For example, to build OpenStack End User Guide, use the following command:
$ tox -e build -- user-guideYou can find the root of the generated HTML documentation at:
doc/user-guide/build/html/index.htmlTo build a specific guide with a PDF file, add a -pdf
option like:
$ tox -e build -- user-guide --pdfThe generated PDF file will be copied to the root directory of the generated HTML documentation.
If you get this message make: xelatex: No such file or directory it means your local environment does not have LaTeX installed. Read Getting LaTeX for instructions.
Testing of changes and building of the manual
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 manualtox -e checklang- to build translated manualstox -e checkniceness- to run the niceness teststox -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:
Installing
Refer to https://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.