sphinx_quickstart_programmatic_project_setup_with_cli_args.py

1# Sphinx is primarily a command-line tool, but it can be invoked via Python.
2# To start a new project, you typically run the following command in your terminal:
3# $ sphinx-quickstart
4
5# To programmatically trigger the quickstart process from a Python script:
6import sys
7from sphinx.cmd.quickstart import main
8
9# Define the arguments for the quickstart process
10# -q: quiet mode (uses default or provided values without prompting)
11# -p: Project name
12# -a: Author name
13# -v: Version
14# 'docs': The target directory
15args = [
16    "-q",
17    "-p", "My Project",
18    "-a", "Author Name",
19    "-v", "1.0",
20    "docs"
21]
22
23if __name__ == "__main__":
24    # This executes the sphinx-quickstart logic
25    sys.exit(main(args))