Skip to content

Commit 87a1bfc

Browse files
πŸ“ Update mkdocs config
1 parent 5826fb6 commit 87a1bfc

File tree

9 files changed

+1079
-68
lines changed

9 files changed

+1079
-68
lines changed

β€Ž.config/mkdocs.yamlβ€Ž

Lines changed: 138 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,138 @@
1+
copyright: Copyright © 2022-2025 RafaΕ‚ KrupiΕ„ski
2+
docs_dir: ../docs
3+
repo_name: python-lapidary/lapidary-render
4+
repo_url: https://github.com/python-lapidary/lapidary-render
5+
site_description: "Declarative Web API client generator for python"
6+
site_dir: "../site"
7+
site_name: Lapidary Render
8+
site_url: https://lapidary.github.io/lapidary-render
9+
10+
11+
nav:
12+
- index.md
13+
- Conversion:
14+
- OpenAPI: openapi.md
15+
- JSONSchema: json-schema.md
16+
17+
watch:
18+
- mkdocs.yaml
19+
- ../src
20+
- ../Readme.md
21+
22+
23+
validation:
24+
omitted_files: warn
25+
absolute_links: warn
26+
unrecognized_links: warn
27+
28+
29+
theme:
30+
logo: assets/logo.svg
31+
icon:
32+
logo: assets/logo.svg
33+
favicon: assets/logo.svg
34+
name: material
35+
features:
36+
- announce.dismiss
37+
- content.action.view
38+
- content.code.annotate
39+
- content.code.copy
40+
- content.tooltips
41+
- navigation.footer
42+
- navigation.instant.preview
43+
- navigation.path
44+
- navigation.sections
45+
- navigation.tabs
46+
- navigation.tabs.sticky
47+
- navigation.top
48+
- search.highlight
49+
- search.suggest
50+
- toc.follow
51+
palette:
52+
- media: "(prefers-color-scheme)"
53+
toggle:
54+
icon: material/brightness-auto
55+
name: Switch to light mode
56+
- media: "(prefers-color-scheme: light)"
57+
scheme: default
58+
primary: teal
59+
accent: purple
60+
toggle:
61+
icon: material/weather-sunny
62+
name: Switch to dark mode
63+
- media: "(prefers-color-scheme: dark)"
64+
scheme: slate
65+
primary: black
66+
accent: lime
67+
toggle:
68+
icon: material/weather-night
69+
name: Switch to system preference
70+
71+
72+
markdown_extensions:
73+
- attr_list
74+
- admonition
75+
- callouts
76+
- footnotes
77+
- pymdownx.emoji:
78+
emoji_index: !!python/name:material.extensions.emoji.twemoji
79+
emoji_generator: !!python/name:material.extensions.emoji.to_svg
80+
- pymdownx.magiclink
81+
- pymdownx.snippets:
82+
base_path: [!relative $config_dir]
83+
check_paths: true
84+
- pymdownx.superfences
85+
- pymdownx.tabbed:
86+
alternate_style: true
87+
slugify: !!python/object/apply:pymdownx.slugs.slugify
88+
kwds:
89+
case: lower
90+
- pymdownx.tasklist:
91+
custom_checkbox: true
92+
- toc:
93+
permalink: "Β€"
94+
95+
plugins:
96+
- search
97+
- autorefs
98+
- markdown-exec
99+
- section-index
100+
#- coverage
101+
- mkdocstrings:
102+
handlers:
103+
python:
104+
inventories:
105+
- https://docs.python.org/3/objects.inv
106+
paths: [src]
107+
options:
108+
backlinks: tree
109+
docstring_section_style: spacy
110+
docstring_style: sphinx
111+
filters: ["!^_"]
112+
heading_level: 1
113+
members_order: source
114+
merge_init_into_class: true
115+
preload_modules:
116+
- httpx
117+
- pydantic
118+
- typing_extensions
119+
separate_signature: true
120+
show_root_full_path: false
121+
show_root_heading: true
122+
show_signature_annotations: true
123+
show_source: true
124+
show_symbol_type_heading: true
125+
show_symbol_type_toc: true
126+
signature_crossrefs: true
127+
summary: true
128+
- minify:
129+
minify_html: !ENV [DEPLOY, false]
130+
131+
extra:
132+
social:
133+
- icon: fontawesome/brands/github
134+
link: https://github.com/rafalkrupinski
135+
- icon: fontawesome/brands/mastodon
136+
link: https://101010.pl/@mattesilver
137+
- icon: fontawesome/brands/python
138+
link: https://pypi.org/project/lapidary-render/

β€Ž.config/mkdocs.ymlβ€Ž

Lines changed: 0 additions & 9 deletions
This file was deleted.

β€Ž.gitignoreβ€Ž

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
/dist/
22
__pycache__/
3+
/site/

β€Ž.pre-commit-config.yamlβ€Ž

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,20 +5,21 @@ default_language_version:
55
python: '3.13'
66
repos:
77
- repo: https://github.com/pre-commit/pre-commit-hooks
8-
rev: v5.0.0
8+
rev: v6.0.0
99
hooks:
1010
- id: check-added-large-files
1111
- id: check-merge-conflict
1212
- id: check-toml
1313
- id: check-yaml
14+
exclude: .config/mkdocs.yaml
1415
- id: debug-statements
1516
- id: end-of-file-fixer
1617
- id: no-commit-to-branch
1718
- id: trailing-whitespace
1819
# keep whitespaces as generated by libCST for e2e tests
1920
exclude: ^tests/e2e/expected/
2021
- repo: https://github.com/astral-sh/ruff-pre-commit
21-
rev: v0.9.9
22+
rev: v0.13.1
2223
hooks:
2324
- id: ruff
2425
name: ruff-check
@@ -27,12 +28,12 @@ repos:
2728
- --fix
2829
- id: ruff-format
2930
- repo: https://github.com/python-poetry/poetry
30-
rev: 2.1.1
31+
rev: 2.2.1
3132
hooks:
3233
- id: poetry-check
3334
- id: poetry-lock
3435
- repo: https://github.com/pre-commit/mirrors-mypy
35-
rev: v1.15.0
36+
rev: v1.18.2
3637
hooks:
3738
- id: mypy
3839
pass_filenames: false

β€Ždocs/assets/logo.svgβ€Ž

Lines changed: 18 additions & 0 deletions
Loading

β€Ždocs/index.mdβ€Ž

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
# Lapidary Render
1+
---
2+
hide:
3+
- navigation
4+
---
25
## Synopsis
36

47
Lapidary-render is a code generator that creates client code from an OpenAPI document.

0 commit comments

Comments
Β (0)