Getting Started¶

Install¶

pip install inari

Use CLI¶

inari <module-name> <out-dir> [-n <out-name>] [-y]

Arguments¶

module-name : Target module to make documents.
out-dir : Directory to put documents.

Options¶

--name (-n) : Top level directory/file name. module-name is used by default.
--enable-yaml-header(-y) : A flag for deciding whether to include yaml header. Default: False.

Use MkDocs Plugin¶

First, install with MkDocs .

pip install inari[mkdocs]

Initialize project.

mkdocs new my-project
cd my-project

Then, fix mkdocs.yml .

site_name: My Docs

docs_dir: "docs" # same as default

plugins:
  - search # MkDocs default plugin
  - inari:
      module: <module-name> # required
      out-name: api # optional. Default: <module-name>
      # no `out-dir` option because `inari` uses `docs_dir` in the config.

After that, running mkdocs build will generate your API documents in docs/api .