Scroll to navigation

OPENSTACK-DOC-TEST(1) OpenStack-doc-tools OPENSTACK-DOC-TEST(1)

NAME

openstack-doc-test - OpenStack documentation tools

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
Special handling for api-site and other API repositories to handle WADL.
File that will be skipped during delete and build checks to generate dependencies. This should be done for invalid XML files only.
Try to build books using modified files.
Check that deleted files are not used.
Check that linked URLs are valid and reachable.
Check the niceness of files, for example whitespace.
Check the syntax of modified files.
Run all checks (default if no arguments are given).
Path to a config file to use. Multiple config files can be specified, with values in later files taking precedence.
Enable debug code.
File that will be skipped during niceness and syntax validation.
Force the validation of all files and build all books.
Show help message and exit.
Directory to ignore for building of manuals. The parameter can be passed multiple times to add several directories.
Build translated manual for language in path generate/$LANGUAGE .
Build each specified manual.
Build books in parallel (default).
Print list of files that are not included anywhere as part of check-build.
Setup content in publish-docs directory for publishing to external website.
Verbose execution.
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

Bugs

openstack-doc-tools is hosted on Launchpad so you can view current bugs at Bugs : openstack-doc-tools

AUTHOR

OpenStack

COPYRIGHT

2018, OpenStack Foundation

August 23, 2018