Initial proper documentation

docs/conf.py

@@ -14,13 +14,18 @@ release = "0.2.1"
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = ["sphinx.ext.duration", "autoapi.extension"]
+extensions = [
+    "myst_parser",
+    "sphinx.ext.duration",
+    "autoapi.extension"
+]
 
 templates_path = ["_templates"]
 exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
 
 # -- AutoAPI Options ---------------------------------------------------------
 autoapi_dirs = ["../findmy/"]
+autoapi_add_toctree_entry = False
 autoapi_options = [
     "members",
     "undoc-members",
@@ -33,5 +38,5 @@ autoapi_options = [
 # -- Options for HTML output -------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
 
-html_theme = "alabaster"
+html_theme = "furo"
 html_static_path = ["_static"]

docs/getstarted/account.md

@@ -0,0 +1,5 @@
+# Logging in
+
+Some useful features of this library require an active login session with Apple in order to work correctly.
+That's because the remote endpoints require authentication to actually retrieve data.
+This page will guide you through the steps needed to log into an Apple account using FindMy.py.

docs/getstarted/index.md

@@ -0,0 +1,10 @@
+# Getting Started
+
+* * *
+
+```{toctree}
+:maxdepth: 1
+:glob:
+
+*
+```

docs/index.md

@@ -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
+```

docs/index.rst

@@ -1,18 +0,0 @@
-.. FindMy.py documentation master file, created by
-   sphinx-quickstart on Tue Jan  2 21:16:55 2024.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to FindMy.py's documentation!
-=====================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/technical/1-Network.md

@@ -0,0 +1,2 @@
+# Overview of the Network
+

docs/technical/index.md

@@ -0,0 +1,17 @@
+# Technical Documentation
+
+This category serves as a place to provide technical documentation about the Find My network.
+More specifically, it serves as a technical reference for how certain features in this
+library have been implemented.
+
+Most of the knowledge in this section has been sourced from other genius minds.
+Make sure to check out the references section on the specific pages to read more about the topics.
+
+* * *
+
+```{toctree}
+:maxdepth: 1
+:glob:
+
+*
+```