.\" Man page generated from reStructuredText.
.
.TH "OPENSTACK-DOC-TEST" "1" "Aug 23, 2018" "" "OpenStack-doc-tools"
.SH NAME
openstack-doc-test \- OpenStack documentation tools
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.SH OPENSTACK VALIDATION TOOL
.SS SYNOPSIS
.sp
openstack\-doc\-test [options]
.SS DESCRIPTION
.sp
openstack\-doc\-test allows to test the validity of the OpenStack
documentation content.
.SS OPTIONS
.INDENT 0.0
.INDENT 3.5
\fBGeneral options\fP
.INDENT 0.0
.TP
\fB\-\-api\-site\fP
Special handling for api\-site and other API repositories
to handle WADL.
.TP
\fB\-\-build\-file\-exception BUILD_FILE_EXCEPTION\fP
File that will be skipped during delete and build checks to
generate dependencies. This should be done for invalid XML files
only.
.TP
\fB\-\-check\-build\fP
Try to build books using modified files.
.TP
\fB\-\-check\-deletions\fP
Check that deleted files are not used.
.TP
\fB\-\-check\-links\fP
Check that linked URLs are valid and reachable.
.TP
\fB\-\-check\-niceness\fP
Check the niceness of files, for example whitespace.
.TP
\fB\-\-check\-syntax\fP
Check the syntax of modified files.
.TP
\fB\-\-check\-all\fP
Run all checks (default if no arguments are given).
.TP
\fB\-\-config\-file PATH\fP
Path to a config file to use. Multiple config files can be
specified, with values in later files taking precedence.
.TP
\fB\-\-debug\fP
Enable debug code.
.TP
\fB\-\-file\-exception FILE_EXCEPTION\fP
File that will be skipped during niceness and syntax validation.
.TP
\fB\-\-force\fP
Force the validation of all files and build all books.
.TP
\fB\-h, \-\-help\fP
Show help message and exit.
.TP
\fB\-\-ignore\-dir IGNORE_DIR\fP
Directory to ignore for building of manuals. The parameter can
be passed multiple times to add several directories.
.TP
\fB\-\-language LANGUAGE, \-l LANGUAGE\fP
Build translated manual for language in path generate/$LANGUAGE .
.TP
\fB\-\-only\-book ONLY_BOOK\fP
Build each specified manual.
.TP
\fB\-\-parallel\fP
Build books in parallel (default).
.TP
\fB\-\-print\-unused\-files\fP
Print list of files that are not included anywhere as part of
check\-build.
.TP
\fB\-\-publish\fP
Setup content in publish\-docs directory for publishing to
external website.
.TP
\fB\-\-verbose\fP
Verbose execution.
.TP
\fB\-\-version\fP
Output version number.
.UNINDENT
.UNINDENT
.UNINDENT
.SS FILES
.sp
Reads the file \fIdoc\-test.conf\fP in the top\-level directory of the git
repository for option processing.
.sp
Building of books will generate in the top\-level directory of the git
repository:
.INDENT 0.0
.IP \(bu 2
a directory \fIpublish\-docs\fP with a copy of the build results.
.IP \(bu 2
for each book build a log file named \fIbuild\-${book}.log.gz\fP\&.
.UNINDENT
.SS SEE ALSO
.INDENT 0.0
.IP \(bu 2
\fI\%OpenStack Documentation\fP
.UNINDENT
.SS Bugs
.INDENT 0.0
.IP \(bu 2
openstack\-doc\-tools is hosted on Launchpad so you can view current
bugs at
\fI\%Bugs : openstack\-doc\-tools\fP
.UNINDENT
.SH AUTHOR
OpenStack
.SH COPYRIGHT
2018, OpenStack Foundation
.\" Generated by docutils manpage writer.
.