Filters
List of Filters
upper
Use upper case letters for package and module object.
module
filter
Classes
C
— Class.
Functions
func
(
x
)
— Function.gen
(
)
(int) — Generator.
MODULE
FILTER
Classes
C
— Class.
Functions
func
(
x
)
— Function.gen
(
)
(int) — Generator.
short
Remove prefix.
class
filter.
C
(
)
Class.
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.
function
filter.
func
(
x
)
Function.
Parameters
x
(int) —
Scope of Filters
Page Scope
For page scope filters, use empty object.
generator
gen
(
)
→ intGenerator.
class
C
(
)
Class.
Global Scope
In mkdocs.yaml
, select global filters: