e83d3baffc
* Will build PDF by default when using publish though. Change-Id: I3fc45c4ff657a394316a0bc5d71b2260507b80b3
116 lines
3.1 KiB
ReStructuredText
116 lines
3.1 KiB
ReStructuredText
========================
|
|
Team and repository tags
|
|
========================
|
|
|
|
.. image:: https://governance.openstack.org/badges/openstack-manuals.svg
|
|
:target: https://governance.openstack.org/reference/tags/index.html
|
|
|
|
.. Change things from this point on
|
|
|
|
OpenStack Manuals
|
|
+++++++++++++++++
|
|
|
|
This repository contains documentation for the OpenStack project.
|
|
|
|
For more details, see the `OpenStack Documentation Contributor
|
|
Guide <https://docs.openstack.org/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 (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.
|
|
|
|
To install all requirements to execute the commands above, on Linux you can
|
|
check the output of the ``bindep`` command. This tool reports missing
|
|
requirements for all build targets::
|
|
|
|
$ tox -e bindep
|
|
|
|
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
|
|
<https://www.latex-project.org/get/>`_ 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 :command:`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
|
|
<https://docs.openstack.org/contributor-guide/doc-tools.html>`_.
|
|
|
|
|
|
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.
|