101 lines
2.3 KiB
ReStructuredText
101 lines
2.3 KiB
ReStructuredText
==================
|
|
openstack-doc-test
|
|
==================
|
|
|
|
------------------------------------------------------
|
|
OpenStack Validation tool
|
|
------------------------------------------------------
|
|
|
|
SYNOPSIS
|
|
========
|
|
|
|
openstack-doc-test [options]
|
|
|
|
DESCRIPTION
|
|
===========
|
|
|
|
openstack-doc-test allows to test the validity of the OpenStack documentation content.
|
|
|
|
OPTIONS
|
|
=======
|
|
|
|
**General options**
|
|
|
|
**--api-site**
|
|
Special handling for api-site and other API repositories
|
|
to handle WADL.
|
|
|
|
**--check-build**
|
|
Try to build books using modified files.
|
|
|
|
**--check-syntax**
|
|
Check the syntax of modified files.
|
|
|
|
**--check-deletions**
|
|
Check that deleted files are not used.
|
|
|
|
**--check-niceness**
|
|
Check the niceness of files, for example whitespace.
|
|
|
|
**--check-all**
|
|
Run all checks (default if no arguments are given).
|
|
|
|
**--config-file PATH**
|
|
Path to a config file to use. Multiple config files can be
|
|
specified, with values in later files taking precedence.
|
|
|
|
**--debug**
|
|
Enable debug code.
|
|
|
|
**--file-exception FILE_EXCEPTION**
|
|
File that will be skipped during validation.
|
|
|
|
**--force**
|
|
Force the validation of all files and build all books.
|
|
|
|
**-h, --help**
|
|
Show help message and exit.
|
|
|
|
**--ignore-dir IGNORE_DIR**
|
|
Directory to ignore for building of manuals. The parameter can
|
|
be passed multiple times to add several directories.
|
|
|
|
**--ignore-errors**
|
|
Do not exit on failures.
|
|
|
|
**--language LANGUAGE, -l LANGUAGE**
|
|
Build translated manual for language in path generate/$LANGUAGE .
|
|
|
|
**--only-book ONLY_BOOK**
|
|
Build each specified manual.
|
|
|
|
**--verbose**
|
|
Verbose execution.
|
|
|
|
**--version**
|
|
Output version number.
|
|
|
|
FILES
|
|
=====
|
|
|
|
Reads the file `doc-test.conf` in the top-level directory of the git
|
|
repository for option processing.
|
|
|
|
Building of books will generate in the top-level directory of the git
|
|
repository:
|
|
|
|
* a directory `publish-docs` with a copy of the build results.
|
|
* for each book build a log file named `build-${book}.log.gz`.
|
|
|
|
SEE ALSO
|
|
========
|
|
|
|
* `OpenStack Documentation <http://wiki.openstack.org/wiki/Documentation>`__
|
|
|
|
Bugs
|
|
====
|
|
|
|
* openstack-doc-tools is hosted on Launchpad so you can view current
|
|
bugs at
|
|
`Bugs : openstack-manuals <https://bugs.launchpad.net/openstack-manuals/>`__
|