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
|
loaders:
- type: python
search_path: [..]
processors:
- type: filter
- type: pydoc_markdown_shtab.ShtabProcessor
- type: crossref
hooks:
pre-render:
- sed 's#](./#](https://github.com/iterative/shtab/tree/main/#g' ../CONTRIBUTING.md > contributing.md
renderer:
type: mkdocs
markdown:
source_linker:
type: github
repo: iterative/shtab
root: ..
source_position: before signature
source_format: |
<span style="float: right; font-size: 75%;">
[[view source]]({url})
</span>
pages:
- title: Home
name: index
source: index.md
- title: Usage
name: use
source: use.md
- title: Reference
name: ref
contents: [shtab.complete, shtab.add_argument_to]
- title: External Links
children:
- title: Source Code
href: https://github.com/iterative/shtab
- title: Changelog
href: https://github.com/iterative/shtab/releases
- title: Issues
href: https://github.com/iterative/shtab/issues?q=
- title: Contributing
name: contributing
source: contributing.md
- title: Licence
name: licence
source: ../LICENCE
mkdocs_config:
site_name: shtab documentation
site_description: Automagic shell tab completion for Python CLI applications
site_url: https://docs.iterative.ai/shtab/
site_author: Iterative
repo_name: iterative/shtab
repo_url: https://github.com/iterative/shtab
copyright: |
© Casper da Costa-Luis <a href="https://github.com/casperdcl">@casperdcl</a> 2021
extra:
generator: false
theme:
name: material
logo: https://github.com/iterative/shtab/raw/main/meta/logo.png
favicon: https://github.com/iterative/shtab/raw/main/meta/logo.png
features: [content.tabs.link]
palette:
- scheme: default
primary: white
toggle:
icon: material/toggle-switch-off-outline
name: Switch to dark mode
- scheme: slate
primary: orange
toggle:
icon: material/toggle-switch
name: Switch to light mode
plugins:
- search
- minify:
minify_js: true
minify_html: true
markdown_extensions:
- admonition
- toc:
permalink: '#'
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
|
