MkApi

Filters

List of Filters

upper

Use upper case letters for package and module object.

### ![mkapi](filter)
module

filter

Classes
  • C — Class.
Functions
  • func(x) — Function.
  • gen() (int) — Generator.
### ![mkapi](filter|upper)
MODULE

FILTER

Classes
  • C — Class.
Functions
  • func(x) — Function.
  • gen() (int) — Generator.

short

Remove prefix.

![mkapi](filter.C)
class
filter.C()

Class.

![mkapi](filter.C|short)
class
C()

Class.

short_nav

Remove prefix from nav items. For example,

nav:
  - index.md
  - API: mkapi/api/mkapi|short_nav

[2] () ()

strict

Show parameters and attributes even if their description is missing.

![mkapi](filter.func|strict)
function
filter.func(x)

Function.

Parameters
  • x (int) —

Scope of Filters

Page Scope

For page scope filters, use empty object.

![mkapi](|short)
![mkapi](filter.gen)
![mkapi](filter.C)
generator
gen() → int

Generator.

class
C()

Class.

Global Scope

In mkdocs.yaml, select global filters:

# mkdocs.yml
plugins:
  - search
  - mkapi:
      src_dirs: [examples]
      filters: [short, strict]