workspace_docs.py File Reference

Go to the source code of this file.

Namespaces
namespace	oct
namespace	oct.docs
namespace	oct.docs.workspace_docs

Functions
bool	oct.docs.workspace_docs.is_workspace_root (Path path)
str|None	oct.docs.workspace_docs._doxygen_withheld (Subproject sp)
int	oct.docs.workspace_docs._build_subproject (Subproject sp, *, WorkspaceDocsMode mode)
None	oct.docs.workspace_docs._copytree_replace (Path src, Path dst)
Path	oct.docs.workspace_docs._aggregate (Path ws_root, Workspace workspace, *, WorkspaceDocsMode mode)
int	oct.docs.workspace_docs._clean_workspace (Path ws_root, Workspace workspace, *, bool dry_run)
int	oct.docs.workspace_docs.run_workspace_docs (Path ws_root, *, WorkspaceDocsMode mode, bool dry_run=False)

Variables
	oct.docs.workspace_docs.WorkspaceDocsMode = Literal["sphinx", "doxygen", "typedoc", "all", "clean"]
str	oct.docs.workspace_docs.SITE_DIRNAME = "_site"
Path	oct.docs.workspace_docs._SPHINX_BUILD_REL = Path("docs") / "html"
Path	oct.docs.workspace_docs._DOXYGEN_BUILD_REL = Path("docs") / "doxygen_output" / "html"