forked from tefra/xsdata
-
Notifications
You must be signed in to change notification settings - Fork 0
/
mkdocs.yml
127 lines (121 loc) · 3.47 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
site_name: "xsdata"
site_url: https://xsdata.readthedocs.io/
site_description: >-
xsData is a complete data binding library for python allowing developers to
access and use XML and JSON documents as simple objects rather than using DOM.
repo_name: tefra/xsdata
repo_url: https://github.com/tefra/xsdata
edit_uri: edit/main/docs/
exclude_docs: |
scripts/
__pycache__/
theme:
name: 'material'
custom_dir: docs/overrides
palette:
- media: "(prefers-color-scheme: light)"
scheme: default
primary: white
accent: deep purple
toggle:
icon: material/lightbulb-outline
name: "Switch to dark mode"
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: deep purple
toggle:
icon: material/lightbulb
name: "Switch to light mode"
features:
- content.action.edit
- content.action.view
- content.code.annotate
- content.code.copy
- content.tooltips
- navigation.tabs
- navigation.footer
- navigation.top
- content.tabs.link
- search.suggest
logo: 'logo-small.svg'
favicon: 'favicon.png'
watch:
- xsdata
plugins:
- search
- minify:
minify_html: true
- markdown-exec
- gen-files:
scripts:
- docs/scripts/generate_api.py
- literate-nav:
nav_file: SUMMARY.md
- mkdocstrings:
handlers:
python:
load_external_modules: true
options:
members_order: source
show_source: true
show_root_heading: true
import:
- https://docs.python-requests.org/en/master/objects.inv
- https://docs.python.org/3/objects.inv
- https://lxml.de/apidoc/objects.inv
markdown_extensions:
- admonition
- pymdownx.details
- pymdownx.snippets:
dedent_subsections: true
- pymdownx.superfences:
custom_fences:
- name: "*"
class: "highlight"
format: !!python/name:pymdownx_superfence_filter_lines.do_format
validator: !!python/name:pymdownx_superfence_filter_lines.do_validate
- name: mermaid
class: mermaid
format: !!python/name:pymdownx.superfences.fence_code_format
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
nav:
- Get Started:
- Welcome to xsdata: index.md
- Installation: installation.md
- Changelog: changelog.md
- Samples: samples.md
- PyPI: https://pypi.org/project/xsdata/
- Conda: https://anaconda.org/conda-forge/xsdata
- Code Generator:
- Introduction: codegen/intro.md
- Configuration: codegen/config.md
- Docstring styles: codegen/docstrings.md
- DTD Modeling: codegen/dtd_modeling.md
- WSDL Modeling: codegen/wsdl_modeling.md
- Samples Modeling: codegen/samples_modeling.md
- Download Schemas: codegen/download_schemas.md
- Architecture: codegen/architecture.md
- Data Models:
- Classes: models/classes.md
- Fields: models/fields.md
- Types: models/types.md
- Data Binding:
- Basics: data_binding/basics.md
- XML Parsing: data_binding/xml_parsing.md
- XML Serializing: data_binding/xml_serializing.md
- JSON Parsing: data_binding/json_parsing.md
- JSON Serializing: data_binding/json_serializing.md
- Pycode Serializing: data_binding/pycode_serializing.md
- Tree Serializing: data_binding/tree_serializing.md
- Dict Decoding: data_binding/dict_decoding.md
- Dict Encoding: data_binding/dict_encoding.md
- FAQ: faq.md
- API: api/
- Plugins:
- How-to: plugins/how_to.md
- List: plugins/list.md