openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
18,931 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
478e3f22cc
Go to file
Stephen Finucane 478e3f22cc Use Sphinx 1.5 warning-is-error 
With pbr 2.0 and Sphinx 1.5, the setting for treat sphinx warnings as
errors is setting warning-is-error in build_sphinx section. Migrate
the setting from the old warnerrors one.

Remove all-files, we do not have man pages.

Note that the build_sphinx section is not used by our toolchain, still
doesn't harm to use proper setup so that it could be used.

Change-Id: I03403b1ed20c4a4bccb1c03311d3999e12a98416
2017-03-16 17:11:23 +00:00
doc Use Sphinx 1.5 warning-is-error 2017-03-16 17:11:23 +00:00
releasenotes Huawei: Update huawei cinder driver configuration file for ocata. 2017-03-13 02:20:50 +00:00
tools Merge "[arch-design] Publish draft Arch Guide to docs.openstack.org" 2017-03-09 06:20:36 +00:00
www Adding storlets to www/developer 2017-03-10 10:16:45 +02:00
.gitignore Add "*.swo" to ".gitignore" file 2016-08-09 06:18:46 +00:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
bindep.txt Remove obsolete binary packages from install 2017-02-24 13:27:52 +00:00
CONTRIBUTING.rst Use https instead of http for openstack sites 2017-01-31 07:36:48 +09:00
doc-tools-check-languages.conf [arch-design] Publish draft Arch Guide to docs.openstack.org 2017-03-08 23:02:35 +00:00
LICENSE bug 944097 adding apache license to openstack-manuals repo 2012-03-09 08:37:46 -06:00
projects.txt Stop syncing common to api-site/first-app 2017-02-11 22:04:19 +09:00
README.rst Indicate bindep is for Linux only 2017-03-08 13:43:41 +00:00
test-requirements.txt Update hacking test requirement 2017-03-06 12:19:16 +00:00
tox.ini Does not build PDF by default with tox -e docs 2017-03-01 20:20:27 +09:00

README.rst

Team and repository tags

image

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 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 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

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

$ tox -e build -- user-guide --pdf

The 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 manual
  • tox -e checklang - to build translated manuals
  • tox -e checkniceness - to run the niceness tests
  • 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

Installing

Refer to https://docs.openstack.org to see where these documents are published and to learn more about the OpenStack project.