chpldoc¶

SYNOPSIS¶

chpldoc [-o directory]

[--author authortext]
[--save-sphinx directory]
[options] source-files…

DESCRIPTION¶

chpldoc is a tool for generating HTML based documentation from Chapel source code and its comments. It does this by parsing Chapel source files and associating comments with symbols, then generating reStructuredText, and finally building the output documentation with Sphinx. Most users will not need to be aware of the use of reStructuredText as an intermediate format.

Documentation Options

-o, --output-dir <dirname>

Specify the directory name into which documentation should be saved (defaults to ‘docs’ if unspecified).

--author <authortext>

Documentation author string. authortext becomes the copyright and author in the output documentation.

--comment-style <string>

Specify the opening comment character sequence used to distinguish a documentation comment from a normal one (defaults to ‘/*’ if unspecified).

--process-used-modules

By default, chpldoc only generates documentation for the source file(s) named on the command-line. When this flag is thrown, modules that it ‘use’s are also parsed and processed.

--save-sphinx <directory>

Save generated Sphinx project in directory.

--text-only

Generate text-based documentation instead of HTML. Takes precedence over --[no-]html

--[no-]html

[Don’t] generate HTML-based documentation (on by default)

--project-version <projectversion>

Sets the documentation version to projectversion (documentation version defaults to ‘0.0.1’ if unspecified).

--legacy

Use the legacy version of chpldoc

--[no-]print-commands

Prints the system commands that chpldoc executes in order to create the documentation.

Information Options

-h, --help

Print a list of the command line options, indicating the arguments that they expect and a brief summary of their purpose.

--help-env

Print the command line option help message, listing the environment variable equivalent for each flag, if applicable (see ENVIRONMENT), and its current value.

--help-settings

Print the command line option help message, listing the current setting of each option as specified by environment variables and other flags on the command line.

--version

Print chpldoc‘s version number.

--copyright

Print chpldoc‘s copyright information.

--license

Print chpldoc‘s license information.

ENVIRONMENT¶

Some command-line options have an environment variable that can be used to specify a default value. Use the --help-env option to list the environment variable equivalent for each option. Command-line options will always override environment variable settings in the event of a conflict.

If the environment variable equivalent is set to empty, it is considered unset. This does not apply to options expecting a string or a path.

For options that can be used with or without the leading --no (they are shown with “[no-]” in the help text), the environment variable equivalent, when set to a non-empty string, has the following effect. When the first character of the string is one of:

Y y T t 1 - same as passing the option without --no,

N n F f 0 - same as passing the option with --no,

anything else - generates an error.

For the other options that enable, disable or toggle some feature, any non-empty value of the environment variable equivalent has the same effect as passing that option once.

BUGS¶

See $CHPL_HOME/doc/rst/usingchapel/bugs.rst for instructions on reporting bugs.

AUTHORS¶

See $CHPL_HOME/CONTRIBUTORS.md for a list of contributors to Chapel.