typedoc.py File Reference

Go to the source code of this file.

Namespaces
namespace	oct
namespace	oct.docs
namespace	oct.docs.typedoc

Functions
bool	oct.docs.typedoc.has_typedoc (Path project_dir)
Path	oct.docs.typedoc.typedoc_output_dir (Path project_dir)
None	oct.docs.typedoc._clear_typedoc_output (Path project_dir)
str|None	oct.docs.typedoc.find_npx ()
int	oct.docs.typedoc.run_docs_typedoc (Path root, *, bool no_workspace=False)

Variables
Path	oct.docs.typedoc.TYPEDOC_CONFIG_REL = Path("typedoc.json")
str	oct.docs.typedoc._DEFAULT_OUT = "docs"
tuple	oct.docs.typedoc._TYPEDOC_HTML_MARKERS = ("index.html", "hierarchy.html", "assets")