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.

The line below could also be written args: sphinx-build . _build.

args:
    -   sphinx-build

The source directory.

    -   .

The output directory.

    -   _build
 

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

#html_ext: .html