Skip to content

Commit c3a1f46

Browse files
committed
Enhance documentation structure and configuration for mkdocs
1 parent ba97bd5 commit c3a1f46

File tree

2 files changed

+10
-0
lines changed

2 files changed

+10
-0
lines changed

docs/index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
---
2+
hide:
3+
- navigation
4+
- toc
5+
---
16
# pyOverkiz
27

38
pyOverkiz is an async Python client for the OverKiz platform, used by vendors like Somfy TaHoma and Atlantic Cozytouch. It lets you authenticate, discover devices, read states, execute commands, and consume gateway events.

mkdocs.yml

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
site_name: pyOverkiz Documentation
2+
repo_url: https://github.com/iMicknl/python-overkiz-api
3+
edit_uri: edit/main/docs/
24

35
docs_dir: docs
46

@@ -19,6 +21,9 @@ plugins:
1921
options:
2022
show_source: true
2123
docstring_style: google
24+
show_signature: true
25+
show_signature_annotations: true
26+
signature_crossrefs: true
2227

2328
markdown_extensions:
2429
- pymdownx.highlight

0 commit comments

Comments
 (0)