/
pydocmd.yml
43 lines (38 loc) · 1.62 KB
/
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
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
site_name: "Autorank"
# 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:
- autorank.md:
- autorank.autorank
- autorank.create_report
- autorank.plot_stats
- autorank.latex_table
- autorank.latex_report
# 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.
pages:
- Home: index.md << README.md
- autorank: autorank.md
# These options all show off their default values. You don't have to add
# them to your configuration if you're fine with the default.
docs_dir: docs
gens_dir: _build/pydocmd # This will end up as the MkDocs 'docs_dir'
site_dir: _build/site
theme: readthedocs
loader: pydocmd.loader.PythonLoader
preprocessor: pydocmd.preprocessors.simple.Preprocessor
# Whether to output headers as markdown or HTML. Used to workaround
# https://github.com/NiklasRosenstein/pydoc-markdown/issues/11. The default is
# to generate HTML with unique and meaningful id tags, which can't be done with
# markdown.
#
# Note: if using the simple generator mode, this will default to 'markdown'
# instead of 'html'.
headers: html
# Additional search path for your Python module. If you use Pydocmd from a
# subdirectory of your project (eg. docs/), you may want to add the parent
# directory here.
#additional_search_paths: