1.7 KiB
1.7 KiB
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
- --verbose
Verbose execution.
- --version
Output version number.
- -, --help
Show help message and exit.
- --force
Force the validation of all files and build all books.
- --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).
- --ignore-errors
Do not exit on failures.
- --api-site
Special handling for api-site and other API repositories to handle WADL.
- --ignore-dir IGNORE_DIR
Directory to ignore for building of manuals. The parameter can be passed multiple times to add several directories.
- --exceptions-file EXCEPTIONS_FILE
File that contains filenames that will be skipped during validation.
FILES
None
SEE ALSO
Bugs
- openstack-doc-tools is hosted on Launchpad so you can view current bugs at Bugs : openstack-manuals