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.
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.
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}
: thesource_path
above, but as an absolute path.{output_path}
: theoutput_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}
.
html_ext
: optional; defaults to .html
. The extension used by this renderer when generating HTML files.
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
.