codechat_config.yaml - Configuration for a CodeChat project

This file defines the configuration for a CodeChat project. It contains a working Sphinx configuration.

source_path: optional; defaults to . (the current directory). A path to the root of the source tree. Relative paths are rooted in the directory containing this configuration file.

#source_path: .
 

output_path: required. A path to the root of the HTML output produced by this renderer. Relative paths are rooted in the directory containing this configuration file.

output_path: _build
 

args: required string or sequence of strings. This provides the arguments to invoke the renderer. These strings may optionally contain the following replacement values:

• {project_path}: an absolute path to the directory containing this file.

• {source_path}: the source_path above, but as an absolute path.

• {output_path}: the output_path above, but as an absolute path.

• {sys_executable}: the value of the running Python’s sys.executable.

The line below could also be written args: {sys_executable} -m sphinx {source_path} {output_path}.

args:

Run this in the same virtual environment that CodeChat was installed in. This replacement string must be surrounded with quotes to avoid confusing the YAML parser.

    -   "{sys_executable}"
    -   -m

The sphinx module invokes sphinx-build.

    -   sphinx

The source directory, with quotes as explained above.

    -   "{source_path}"

The output directory, with quotes as explained above.

    -   "{output_path}"
 

html_ext: optional; defaults to .html. The extension used by this renderer when generating HTML files.

#html_ext: .html
 

project_type: optional; defaults to general. Define the project type, which enables special processing based on the type. Valid values are general (no special processing), Doxygen, and PreTeXt.

#project_type: general