-
Notifications
You must be signed in to change notification settings - Fork 0
/
pydocmd.yml
39 lines (35 loc) · 1.34 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
site_name: Smores
theme: readthedocs
repo_url: https://github.com/codylandry/Smores
site_author: Cody Landry
# 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:
- api/smores.md:
- smores.smores:
- smores.smores.Smores+
- api/fields.md:
- smores.smores.TemplateString+
- smores.smores.TemplateFile+
- api/utils.md:
- smores.utils+
# 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
- API:
- Smores: api/smores.md
- Fields: api/fields.md
- Utils: api/utils.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: sources
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.preprocessor.Preprocessor
google_analytics: ['UA-110318840-1', 'Smores Docs']