-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathmkdocs.yml
142 lines (136 loc) · 3.66 KB
/
mkdocs.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
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
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
site_name: JiraGen
site_description: AI-Powered JIRA Issue Generation Tool
site_author: Abdellah Laassairi
site_url: https://github.com/Abdellah-Laassairi/jiragen
repo_name: Abdellah-Laassairi/jiragen
repo_url: https://github.com/Abdellah-Laassairi/jiragen
nav:
- 🏠 Home: index.md
- 📚 User Guide:
- 🚀 Getting Started: getting-started.md
- 🔧 CLI Reference:
- Overview: cli/index.md
- Basic Commands: cli/basic.md
- Issue Generation: cli/generate.md
- Codebase Management: cli/codebase.md
- JIRA Integration: cli/jira.md
- 📝 Templates: templates.md
- ⚙️ Configuration: configuration.md
- 💻 API Reference:
- Overview: api/index.md
- Core API: api/core.md
- CLI API: api/cli.md
- 🤝 Contributing:
- Contributing Guide: contributing.md
- Code of Conduct: code-of-conduct.md
- Development Guide: development.md
- 📰 Changelog: changelog.md
theme:
name: material
logo: assets/logo_white.svg
favicon: assets/logo_light.svg
custom_dir: docs/overrides
icon:
repo: fontawesome/brands/github
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: blue
accent: blue
toggle:
icon: material/weather-sunny
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: blue
accent: blue
toggle:
icon: material/weather-night
name: Switch to light mode
features:
- navigation.instant
- navigation.tracking
- navigation.sections
- navigation.expand
- navigation.top
- search.highlight
- search.share
- search.suggest
- content.code.copy
- content.code.annotate
- content.tabs.link
- toc.follow
plugins:
- search
- social
- tags
- git-revision-date-localized:
enable_creation_date: true
- mkdocstrings:
default_handler: python
handlers:
python:
paths: [jiragen]
options:
docstring_style: google
docstring_section_style: list
show_root_heading: true
show_source: false
show_bases: true
heading_level: 3
members_order: source
show_category_heading: true
show_if_no_docstring: false
show_signature_annotations: true
separate_signature: true
unwrap_annotated: true
merge_init_into_class: true
docstring_options:
ignore_init_summary: true
filters:
- "!^_" # Hide private members
- "!^__" # Hide special members
markdown_extensions:
- admonition
- attr_list
- def_list
- footnotes
- meta
- md_in_html
- tables
- toc:
permalink: true
toc_depth: 4
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
use_pygments: true
default_lang: python
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.snippets
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/Abdellah-Laassairi/jiragen
- icon: fontawesome/brands/python
link: https://pypi.org/project/jiragen
copyright: Copyright © 2025 Abdellah Laassairi