Module inari.mkdocs_plugin

Classes

Plugin

class Plugin()

MkDocs Plugin class.

---

Base classes

• mkdocs.BasePlugin

---

Methods

on_config

def on_config(self, config: Config, **kw: Any) -> Config

---

on_pre_build

def on_pre_build(self, config: Config) -> None

Build markdown docs from python modules.

---

on_serve

def on_serve(
    self,
    server: LiveReloadServer,
    config: Config,
    builder: Callable[[], None],
    **kw: Any
    ) -> LiveReloadServer

---

root_module

def root_module(self, config: Config) -> ModuleCollector