run_sphinx(root_dir, job_count=1, warnings_as_errors=False)¶
Run the Sphinx build process.
Root directory of the Sphinx project and content source. This directory contains both the root
index.rstfile and the
Number of cores to run the Sphinx build with (
Sphinx status code.
0is expected. Greater than
0indicates an error.
This function implements similar internals to Sphinx’s own
sphinx-buildcommand. Most configurations are hard-coded to defaults appropriate for building stack documentation, but flexibility can be added later as needs are identified.
- Return type