-
Notifications
You must be signed in to change notification settings - Fork 1
Expand file tree
/
Copy pathmkdocs.yml
More file actions
184 lines (174 loc) · 4.86 KB
/
mkdocs.yml
File metadata and controls
184 lines (174 loc) · 4.86 KB
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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
# MkDocs configuration for Sankhya SDK Python
# Documentation: https://www.mkdocs.org/
site_name: Sankhya SDK Python
site_description: SDK Python para integração com API Sankhya (ERP)
site_author: Equipe Onix Brasil
site_url: https://github.com/onixbrasil/Sankhya-SDK-python
# Repository
repo_name: Sankhya-SDK-python
repo_url: https://github.com/onixbrasil/Sankhya-SDK-python
edit_uri: edit/main/docs/
# Copyright
copyright: Copyright © 2024 Equipe Onix Brasil
# Theme Configuration
theme:
name: material
language: pt-BR
palette:
# Light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
accent: amber
toggle:
icon: material/brightness-7
name: Mudar para modo escuro
# Dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: deep purple
accent: amber
toggle:
icon: material/brightness-4
name: Mudar para modo claro
features:
- navigation.instant
- navigation.instant.prefetch
- navigation.tracking
- navigation.tabs
- navigation.tabs.sticky
- navigation.sections
- navigation.expand
- navigation.path
- navigation.indexes
- navigation.top
- search.suggest
- search.highlight
- search.share
- content.tabs.link
- content.code.copy
- content.code.annotate
icon:
repo: fontawesome/brands/github
logo: material/code-braces
font:
text: Inter
code: JetBrains Mono
# Plugins
plugins:
- search:
lang: pt
- mkdocstrings:
handlers:
python:
paths: [.]
options:
show_source: true
show_root_heading: true
show_root_full_path: false
show_symbol_type_heading: true
show_symbol_type_toc: true
docstring_style: google
docstring_section_style: spacy
members_order: source
separate_signature: true
signature_crossrefs: true
merge_init_into_class: true
filters:
- "!^_"
- "^__init__$"
- mermaid2:
arguments:
theme: neutral
# Markdown Extensions
markdown_extensions:
- abbr
- admonition
- attr_list
- def_list
- footnotes
- md_in_html
- tables
- toc:
permalink: true
toc_depth: 3
- pymdownx.arithmatex:
generic: true
- pymdownx.betterem:
smart_enable: all
- pymdownx.caret
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator: !!python/name:material.extensions.emoji.to_svg
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
auto_title: true
- pymdownx.inlinehilite
- pymdownx.keys
- pymdownx.magiclink:
repo_url_shorthand: true
user: onixbrasil
repo: Sankhya-SDK-python
- pymdownx.mark
- pymdownx.smartsymbols
- pymdownx.superfences:
custom_fences:
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
- pymdownx.tasklist:
custom_checkbox: true
- pymdownx.tilde
# Navigation
nav:
- Início: index.md
- Início Rápido:
- getting-started/index.md
- Instalação: getting-started/installation.md
- Início Rápido: getting-started/quick-start.md
- Autenticação: getting-started/authentication.md
- Conceitos Fundamentais:
- core-concepts/index.md
- Arquitetura: core-concepts/architecture.md
- Gerenciamento de Sessões: core-concepts/session-management.md
- Sistema de Entidades: core-concepts/entity-system.md
- Tratamento de Erros: core-concepts/error-handling.md
- Referência da API:
- api-reference/index.md
- Core: api-reference/core.md
- Enumerações: api-reference/enums.md
- Exceções: api-reference/exceptions.md
- Modelos: api-reference/models.md
- Request Wrappers: api-reference/request-wrappers.md
- Helpers: api-reference/helpers.md
- Validações: api-reference/validations.md
- Exemplos:
- examples/index.md
- Operações CRUD: examples/crud-operations.md
- Requisições Paginadas: examples/paged-requests.md
- Gerenciamento de Sessões: examples/session-management.md
- Operações com Arquivos: examples/file-operations.md
- Queries Avançadas: examples/advanced-queries.md
- Tratamento de Erros: examples/error-handling.md
- Entidades Customizadas: examples/custom-entities.md
# Extra Configuration
extra:
social:
- icon: fontawesome/brands/github
link: https://github.com/onixbrasil
name: Onix Brasil no GitHub
generator: false
version:
provider: mike
default: latest
# Extra CSS
extra_css:
- assets/stylesheets/extra.css
# Extra JavaScript
extra_javascript:
- assets/javascripts/extra.js