Inputs of the Action¶

All paths are relative to the working directory (the repository root), and must be in it.

Input	Default	Meaning
`project-dir`	`.`	the OMNeT++ project whose NED and MSG files are documented
`output-dir`	`_site`	where the site is built
`title`	name of the project dir	name of the project, which titles the NED reference (“<title> NED Reference”) and the C++ API (“<title> C++ Reference”)
`sphinx-source`		the Sphinx project (the directory of `conf.py`); without it, the site is the NED reference
`ned-dir`	`ned`	where the NED reference is generated in the Sphinx project
`ned-format`	`html-material`	format of the NED reference without Sphinx: `html-material`, `html-readthedocs` or `html`
`ned-path`		NED source roots of dependencies, `;`- or `:`-separated, indexed but not documented
`external-docs`		documentation of dependencies, as `<package>=<url>` items (`opp_docgen -l`)
`docgen-args`		further `opp_docgen` arguments, split at whitespace, without quoting (see `opp_docgen --help` in the image)
`doxygen`	`false`	also generate the C++ API
`doxygen-input`	`<project-dir>/src`	source directories for the bundled doxygen configuration
`doxyfile`		own doxygen configuration instead of the bundled one
`api-dir`	`api`	where the C++ API is generated, in the Sphinx project or in the site
`pdf`	`false`	also build PDFs of the Sphinx project, into the root of the site
`sphinx-args`		further `sphinx-build` arguments, split at whitespace, without quoting, e.g. `-j auto`
`fail-on-warnings`	`false`	fail if `opp_docgen` or Sphinx (also the PDF build) warn
`image-tag`	the action’s version	tag of `ghcr.io/omnetpp/doc-builder`; `latest` if the action is used at another branch or a commit
`image`		image to use instead, as is (`image-tag` does not change it)
`upload-pages-artifact`	`true`	upload the site as the GitHub Pages artifact

Output	Meaning
`site-dir`	absolute path of the built site

The directories that the action generates (output-dir, and ned-dir and api-dir in the Sphinx project) are emptied before each build. A directory that is not empty and was not generated by the action (it has no .doc-builder file) is not touched: the build fails instead.