networktocode/sphinx-docs repository overview

docker pull networktocode/sphinx-docs

./entrypoint.sh [--watch|--serve|--help] [SPHINX_PROJECT]

Entrypoint script for Sphinx container.

Environment variables:
  SPHINX_PROJECT           Name of the Sphinx project to import for Documentation metadata
  SPHINX_SKIP_API_DOCS     Set to to skip generating autodocs
  SPHINX_SKIP_CLEAN        Set to skip cleaning build and API directories
  SPHINX_SKIP_PROJECT      Set to skip project dependency install stage - useful for non-Python or non-standard projects
  SPHINX_DIRECT_INSTALL    Set to do a 'poetry install' direct package install instead of a local install
  SPHINX_PROJECT_PATH      Set to override the default path of /usr/local/src/

Arguments:
  --watch           Watch for Python file changes in the current directory and render and serve documentation as it changes
  --serve           Serve the rendered documentation
  --skip-api        Skip generating API docs
  --skip-clean      Skip cleaning build and API directories
  --skip-project    Skip installing the project and related checks
  --help            Display this help and exit