04b000706d
Change-Id: I6fa8e411928d5f7b0b2d5f5231767c921a086728 Closes-bug: 1509554 |
||
---|---|---|
doc | ||
releasenotes/source | ||
tools | ||
www | ||
.gitignore | ||
.gitreview | ||
bindep.txt | ||
CONTRIBUTING.rst | ||
doc-tools-check-languages.conf | ||
LICENSE | ||
projects.txt | ||
README.rst | ||
test-requirements.txt | ||
tox.ini |
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
All guides are in the RST format. You can use tox
to
prepare virtual environment and build all guides:
$ 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-guide
You can find the root of the generated HTML documentation at:
doc/user-guide/build/html/index.html
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 our
Jenkins gating 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
tox will use the openstack-doc-tools package for execution of these 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.