mirror of
https://github.com/malmeloo/FindMy.py.git
synced 2026-04-18 00:53:56 +02:00
Initial proper documentation
This commit is contained in:
33
docs/index.md
Normal file
33
docs/index.md
Normal file
@@ -0,0 +1,33 @@
|
||||
# FindMy.py
|
||||
|
||||
= 🍏 + 🎯 + 🐍!
|
||||
|
||||
FindMy.py is a Python library aiming to provide everything you need
|
||||
to interact with **Apple's FindMy Network**.
|
||||
Its primary aims are feature completeness, reliability and elegant API design.
|
||||
It abstracts all the heavy lifting away, while keeping the control flow in your hands.
|
||||
|
||||
## Jump To
|
||||
|
||||
[//]: # (This is hidden to prevent it from showing on the home page)
|
||||
```{toctree}
|
||||
:hidden:
|
||||
|
||||
Home <self>
|
||||
```
|
||||
|
||||
[//]: # (Documentation can be expanded to maxdepth 2)
|
||||
```{toctree}
|
||||
:maxdepth: 2
|
||||
|
||||
getstarted/index
|
||||
technical/index
|
||||
```
|
||||
|
||||
[//]: # (Show these with a maxdepth of 1)
|
||||
```{toctree}
|
||||
:maxdepth: 1
|
||||
|
||||
API Reference <autoapi/findmy/index>
|
||||
genindex
|
||||
```
|
||||
Reference in New Issue
Block a user