settings

Settings

Source code in mkreports/md/settings.py

@dataclass
class Settings:
    mkdocs: Dict[str, Any] = field(default_factory=dict)
    page: Dict[str, Any] = field(default_factory=dict)

    def __add__(self, other: "Settings"):
        """
        Merges mkdocs and mkreports.

        For mkdocs, nav will never be merged and an error thrown if attempted.
        """
        if "nav" in self.mkdocs and "nav" in other.mkdocs:
            raise ValueError(
                "Merging of Requirements with 'nav' in mkdocs not supported."
            )
        return Settings(
            mkdocs=merge_settings(self.mkdocs, other.mkdocs),
            page=merge_settings(self.page, other.page),
        )

__add__(other)

Merges mkdocs and mkreports.

For mkdocs, nav will never be merged and an error thrown if attempted.

Source code in mkreports/md/settings.py

def __add__(self, other: "Settings"):
    """
    Merges mkdocs and mkreports.

    For mkdocs, nav will never be merged and an error thrown if attempted.
    """
    if "nav" in self.mkdocs and "nav" in other.mkdocs:
        raise ValueError(
            "Merging of Requirements with 'nav' in mkdocs not supported."
        )
    return Settings(
        mkdocs=merge_settings(self.mkdocs, other.mkdocs),
        page=merge_settings(self.page, other.page),
    )

strategy_append_new(config, path, base, nxt)

prepend nxt to base.

Source code in mkreports/md/settings.py

def strategy_append_new(config, path, base, nxt):
    """prepend nxt to base."""
    del config, path
    return base + [x for x in nxt if x not in base]