-
Notifications
You must be signed in to change notification settings - Fork 33
/
pydocmd.yml
23 lines (21 loc) · 933 Bytes
/
pydocmd.yml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
site_name: "Python bindings for Gluster CLI commands and Metrics"
# This tells pydocmd which pages to generate from which Python modules,
# functions and classes. At the first level is the page name, below that
# is a tree of Python member names (modules, classes, etc.) that should be
# documented. Higher indentation leads to smaller header size.
generate:
- docs/cli.md:
- glustercli.cli.volume++
- glustercli.cli.georep++
- docs/metrics.md:
- glustercli.metrics++
# MkDocs pages configuration. The `<<` operator is sugar added by pydocmd
# that allows you to use an external Markdown file (eg. your project's README)
# in the documentation. The path must be relative to current working directory.
# This configuration is not mandatory if you have your own mkdocs.yml config file.
pages:
- Home: docs/index.md << README.md
- glustercli.cli:
- CLI bindings: docs/cli.md
- glustercli.metrics:
- Metrics: docs/metrics.md