forked from NiklasRosenstein/pydoc-markdown
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathpydoc-markdown.yaml
96 lines (92 loc) · 3.17 KB
/
pydoc-markdown.yaml
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
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
#@ def base_url():
#@ if env.READTHEDOCS:
#@ return "https://pydoc-markdown.readthedocs.io/en/" + env.READTHEDOCS_VERSION + "/"
#@ else:
#@ return None
#@ end
loaders:
- type: python
search_path: [src]
hooks:
pre-render:
- shut changelog -a --markdown >CHANGELOG.md
renderer:
type: mkdocs
mkdocs_config:
site_name: Pydoc-Markdown
theme: readthedocs
repo_url: https://github.com/NiklasRosenstein/pydoc-markdown
output_directory: docs/build
markdown:
source_linker:
type: github
repo: NiklasRosenstein/pydoc-markdown
pages:
- title: Home
name: index
source: README.md
- title: Changelog
name: changelog
source: CHANGELOG.md
- title: Getting Started
source: docs/getting-started.md
- title: Read the Docs
source: docs/readthedocs.md
- title: Configuration
source: docs/configuration.md
- title: Migrate from 3.x to 4.x
name: migrate-from-3x-to-4x
source: docs/migrate-from-3x-to-4x.md
- title: API Documentation
children:
- title: CLI
contents:
- pydoc_markdown.main.cli
- title: Interfaces
contents:
- pydoc_markdown.interfaces.*
- title: Loaders
contents:
- pydoc_markdown.contrib.loaders.python.PythonLoader
- pydoc_markdown.contrib.loaders.python.PythonLoader.*
- title: Processors
contents:
- pydoc_markdown.contrib.processors.crossref.CrossrefProcessor
- pydoc_markdown.contrib.processors.crossref.CrossrefProcessor.*
- pydoc_markdown.contrib.processors.filter.FilterProcessor
- pydoc_markdown.contrib.processors.filter.FilterProcessor.*
- pydoc_markdown.contrib.processors.google.GoogleProcessor
- pydoc_markdown.contrib.processors.google.GoogleProcessor.*
- pydoc_markdown.contrib.processors.pydocmd.PydocmdProcessor
- pydoc_markdown.contrib.processors.pydocmd.PydocmdProcessor.*
- pydoc_markdown.contrib.processors.smart.SmartProcessor
- pydoc_markdown.contrib.processors.smart.SmartProcessor.*
- pydoc_markdown.contrib.processors.sphinx.SphinxProcessor
- pydoc_markdown.contrib.processors.sphinx.SphinxProcessor.*
- title: Renderers
children:
- title: Docusaurus v2
contents:
- pydoc_markdown.contrib.renderers.docusaurus
- pydoc_markdown.contrib.renderers.docusaurus.*
- title: Hugo
contents:
- pydoc_markdown.contrib.renderers.hugo
- pydoc_markdown.contrib.renderers.hugo.HugoPage
- pydoc_markdown.contrib.renderers.hugo.HugoPage.*
- pydoc_markdown.contrib.renderers.hugo.HugoConfig
- pydoc_markdown.contrib.renderers.hugo.HugoConfig.*
- pydoc_markdown.contrib.renderers.hugo.HugoRenderer
- pydoc_markdown.contrib.renderers.hugo.HugoRenderer.*
- title: Jinja2
contents:
- pydoc_markdown.contrib.renderers.jinja2
- pydoc_markdown.contrib.renderers.jinja2.Jinja2Renderer*
- title: MkDocs
contents:
- pydoc_markdown.contrib.renderers.mkdocs
- pydoc_markdown.contrib.renderers.mkdocs.MkdocsRenderer*
- title: Markdown
contents:
- pydoc_markdown.contrib.renderers.markdown
- pydoc_markdown.contrib.renderers.markdown.MarkdownRenderer*