OpenStack Manuals
Go to file
Francesco Di Nucci 96c9857397 feat: add Kali Linux to "Get Images"
Change-Id: I9b73159c79db1331cc704a51e78daeedf10f8015
2024-06-21 12:09:06 +02:00
doc feat: add Kali Linux to "Get Images" 2024-06-21 12:09:06 +02:00
releasenotes/source remove unicode prefix from code 2023-09-27 10:06:37 +08:00
tools Retire ec2-api: remove doc ref 2024-05-10 17:56:30 -07:00
www Add OpenStack-Ansible to guides for Caracal 2024-06-09 05:40:28 +02:00
.gitignore Review CentOS/RHEL packages instructions 2024-04-18 10:11:16 +02:00
.gitreview OpenDev Migration Patch 2019-04-19 19:41:34 +00:00
.zuul.yaml CI: run build jobs on newer distro 2024-04-12 10:05:50 +02:00
bindep.txt CI: run build jobs on newer distro 2024-04-12 10:05:50 +02:00
CONTRIBUTING.rst Switch to OFTC IRC 2021-05-26 19:23:31 +02:00
doc-tools-check-languages.conf Build bn_IN install guide 2020-06-01 11:36:32 +02:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
projects.txt Sync common files to ops and ha guides 2018-11-23 06:21:34 +01:00
README.rst Update readme for openstack-manuals repo 2023-10-02 02:03:47 +09:00
test-requirements.txt Cap jsonschema 3.2.0 as the minimal version 2020-05-26 22:02:46 +02:00
tox.ini Fixes for tox4 2023-01-04 20:01:46 +01:00

OpenStack Manuals

This repository contains documentation for the OpenStack project.

For more details, see the OpenStack Documentation Contributor Guide.

It includes these manuals:

  • API Guide (Quick Start)
  • Documentation Contributor 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 bindep

All 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 Virtual Machine Image Guide, use the following command:

$ tox -e build -- image-guide

You can find the root of the generated HTML documentation at:

doc/image-guide/build/html/index.html

To build a specific guide with a PDF file, add a -pdf option like:

$ tox -e build -- image-guide --pdf

The 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 publishdocs - to actually build the manual; this also generates a directory publish-docs that contains the built files for inspection
  • tox -e publishlang - to build translated manuals
  • tox -e linters - to run the niceness tests, for example, to see extra whitespaces
  • tox -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.