openstack/openstack-manuals
Code Issues Proposed changes
OpenStack Manuals
19,874 Commits 4 Branches 2 Tags 474 MiB
HTML 77.7%
CSS 12.6%
Python 4.9%
JavaScript 3.4%
Shell 1.4%
079714fe21
Go to file
Doug Hellmann 079714fe21 add has_in_tree_htaccess flag to template generator 
Add a flag to tell us which projects have a .htaccess file in their
doc build output.

Change-Id: I0af0e32d9c646d61f4c72599cdc4613299aa5ec9
Depends-On: I236b7b0a9aae065167bd0aef316603d258e4c3c6
Signed-off-by: Doug Hellmann <doug@doughellmann.com>
2017-07-31 17:21:37 -04:00
doc add has_in_tree_htaccess flag to template generator 2017-07-31 17:21:37 -04:00
releasenotes Unified format for the title 'Guide' 2017-07-18 16:47:06 +08:00
tools move series dates into generator 2017-07-25 16:48:59 -04:00
www add has_in_tree_htaccess flag to template generator 2017-07-31 17:21:37 -04:00
.gitignore Cleanup .gitignore 2017-07-21 20:26:29 +02:00
.gitreview Add .gitreview config file for gerrit. 2011-10-24 14:52:07 -04:00
.pydevproject [config-ref] Update api-paste.ini of manila 2017-04-13 19:38:07 +08:00
bindep.txt Simplify conf.py for openstackdocstheme 1.11.0 2017-06-27 07:04:30 +02:00
CONTRIBUTING.rst Use https instead of http for openstack sites 2017-01-31 07:36:48 +09:00
doc-tools-check-languages.conf Stop some guide translations 2017-07-19 08:59:58 +02: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 Merge "Remove the user-guide" 2017-07-18 14:27:25 +00:00
test-requirements.txt [install-guide] The guide is version independent 2017-07-21 21:42:42 +02:00
tox.ini Cleanup tox.ini 2017-07-21 20:25:56 +02: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
  • 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 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.

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.