oct
Loading...
Searching...
No Matches
workspace.Subproject Class Reference

Static Public Attributes

str profile = None
bool nested_git = False
bool html_docs = True
bool html_docs_hub = True
bool html_docs_doxygen = True

Detailed Description

One Option C subproject under a workspace.

Attributes
----------
path
    Absolute path to the subproject root (resolved relative to the
    workspace root at load time).
name
    Display name for the subproject.
profile
    Optional override for the lint profile applied to this
    subproject's files when scoped via the workspace. ``None``
    means "use the subproject's own ``.octrc.json``".
nested_git
    Plan 209: True when this subproject is a foreign nested repo -
    it has its own ``.git`` and owns its own branch policy (e.g.
    ``oc_explorer``). This is the ONLY condition under which a
    subproject's ``git.protected_branches`` opt-out is honored
    verbatim; every other subproject may add to but never remove
    the workspace protected-branch defaults (see
    ``oct.git.policy.is_protected_branch``). Defaults False.
html_docs
    True when ``oct docs`` should build this subproject's HTML
    documentation. False removes it from the generated site
    entirely - no page tree, no aggregated output, no hub card.
    Defaults True, so a manifest written before this field existed
    keeps its previous behaviour.
html_docs_hub
    True when the subproject should get a card on the docs hub
    index page. Defaults True. Independent of *html_docs* only in
    one direction: a subproject that is built may be kept off the
    hub (browsable at a URL without crowding the index), but a
    subproject that is not built can never be carded, so
    ``html_docs=False`` forces this False at load time.
html_docs_doxygen
    True when the subproject's Doxygen output is part of the
    generated docs site (manifest ``html_docs: {"doxygen": <bool>}``).
    Defaults True. False keeps the workspace fan-out from building or
    aggregating it, withdraws any ``_site/<name>/doxygen/`` an earlier
    run left, and drops the Doxygen card from the hub. A direct
    ``oct docs --doxygen`` inside the subproject ignores it.
    ``html_docs=False`` forces this False at load time, for the same
    reason it forces *html_docs_hub* False.

Definition at line 108 of file workspace.py.

Member Data Documentation

◆ html_docs

bool workspace.Subproject.html_docs = True
static

Definition at line 158 of file workspace.py.

◆ html_docs_doxygen

bool workspace.Subproject.html_docs_doxygen = True
static

Definition at line 160 of file workspace.py.

◆ html_docs_hub

bool workspace.Subproject.html_docs_hub = True
static

Definition at line 159 of file workspace.py.

◆ nested_git

bool workspace.Subproject.nested_git = False
static

Definition at line 157 of file workspace.py.

◆ profile

str workspace.Subproject.profile = None
static

Definition at line 156 of file workspace.py.


The documentation for this class was generated from the following file: