Add API reference (with mkdocstrings)

docs/reference/private/abc.md

@@ -0,0 +1,5 @@
+# Utility Abstract Base Classes
+
+These are some internal ABC classes that we utilize in various places.
+
+::: mcproto.utils.abc

docs/reference/private/authentication.md

@@ -0,0 +1,13 @@
+# Internal components for authentication
+
+These are the utility components related to / used in the authentication module.
+
+<!-- TODO: https://github.com/mkdocstrings/mkdocstrings/discussions/699
+-->
+
+::: mcproto.auth.msa.MSAAccount
+    options:
+        show_root_heading: true
+        show_root_toc_entry: true
+        filters:
+            - "^_[^_]"

docs/reference/private/deprecation.md

@@ -0,0 +1,3 @@
+# Deprecation utilities
+
+::: mcproto.utils.deprecation

docs/reference/private/index.md

@@ -0,0 +1,11 @@
+# Private API Reference
+
+This is the reference documentation page for **private** mcproto API.
+
+!!! warning
+
+    Private here means that the functions/classes documented here are only meant to be used internally by the library,
+    **you shouldn't use these in your code** if you're just a user of this library. This page is here mainly as a
+    reference for contributors and for providing proper linkable references. The backwards compatibility of these
+    components will not be guarranteed, which means breaking changes may be introduced between patch versinos without
+    any warnings.

docs/reference/private/protocol.md

@@ -0,0 +1,5 @@
+# Internal components for protocol
+
+These are the utility components related to / used in the protocol module.
+
+::: mcproto.protocol.utils

docs/reference/private/types.md

@@ -0,0 +1,9 @@
+# Internal components for types
+
+These are the utility components related to / used in the types module.
+
+::: mcproto.types.nbt
+    options:
+        show_submodules: true
+        filters:
+            - "^_[^_]"

docs/reference/public/authentication.md

@@ -0,0 +1,11 @@
+# Authentication
+
+::: mcproto.auth.account
+
+::: mcproto.auth.yggdrasil
+
+::: mcproto.auth.msa
+
+::: mcproto.auth.microsoft.oauth
+
+::: mcproto.auth.microsoft.xbox

docs/reference/public/encryption.md

@@ -0,0 +1,6 @@
+# Encryption utilities
+
+The following components are used for encryption related interacions (generally needed during the communication with
+the server, after an encryption request during the login process)
+
+::: mcproto.encryption

docs/reference/public/multiplayer.md

@@ -0,0 +1,5 @@
+# Multiplayer utilities
+
+The following components are used for various multiplayer interacions (generally needed during the server joining process).
+
+::: mcproto.multiplayer

docs/reference/public/packets.md

@@ -0,0 +1,35 @@
+# Packets
+
+## Base classes and interaction functions
+
+::: mcproto.packets
+    options:
+        heading_level: 3
+
+## Handshaking gamestate
+
+::: mcproto.packets.handshaking.handshake
+    options:
+        heading_level: 3
+
+## Status gamestate
+
+::: mcproto.packets.status.ping
+    options:
+        heading_level: 3
+
+::: mcproto.packets.status.status
+    options:
+        heading_level: 3
+
+## Login gamestate
+
+::: mcproto.packets.login.login
+    options:
+        heading_level: 3
+
+## Play gamestate
+
+!!! bug "Work In Progress"
+
+    Packets for the Play gamestate aren't yet implemented.

docs/reference/public/protocol.md

@@ -0,0 +1,9 @@
+# Protocol documentation
+
+This is the documentation for components related to interactions with the minecraft protocol and connection establishing.
+
+::: mcproto.protocol.base_io
+
+::: mcproto.buffer.Buffer
+
+::: mcproto.connection

docs/reference/public/types.md

@@ -0,0 +1,5 @@
+# Types
+
+::: mcproto.types
+    options:
+        show_submodules: true

mkdocs.yml

@@ -36,6 +36,20 @@ nav:
           - Great commits: contributing/guides/great-commits.md
           - Unit Tests: contributing/guides/unit-tests.md
           - Deprecations: contributing/guides/deprecations.md
+  - API Reference:
+      - Protocol: reference/public/protocol.md
+      - Authentication: reference/public/authentication.md
+      - Encryption: reference/public/encryption.md
+      - Multiplayer: reference/public/multiplayer.md
+      - Types: reference/public/types.md
+      - Packets: reference/public/packets.md
+  - Private API Reference:
+      - reference/private/index.md
+      - ABCs: reference/private/abc.md
+      - Deprecation: reference/private/deprecation.md
+      - Authentication: reference/private/authentication.md
+      - Protocol: reference/private/protocol.md
+      - Types: reference/private/types.md
 
 theme:
   name: material
@@ -105,6 +119,34 @@ plugins:
   - mike:
       canonical_version: "latest"
       version_selector: true
+  - mkdocstrings:
+      enable_inventory: true
+      default_handler: python
+      handlers:
+        python:
+          options:
+            docstring_options:
+              ignore_init_summary: true
+            show_root_heading: false
+            show_root_toc_entry: false
+            show_source: false
+            docstring_style: sphinx
+            relative_crossrefs: true
+            scoped_crossrefs: true
+            show_signature_annotations: true
+            signature_crossrefs: true
+            separate_signature: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+            parameter_headings: true
+            show_object_full_path: true
+            docstring_section_style: table
+          import:
+            - url: https://docs.python.org/3.13/objects.inv
+              domains: [std, py]
+            - https://typing-extensions.readthedocs.io/en/latest/objects.inv
+            - https://cryptography.io/en/stable/objects.inv
+            - https://python-semanticversion.readthedocs.io/en/stable/objects.inv
 
 extra:
   version:

pyproject.toml

@@ -67,6 +67,7 @@ mkdocs-material = "^9.5.30"
 mike = "^2.1.2"
 markdown-exec = { extras = ["ansi"], version = "^1.9.3" }
 towncrier = "==24.7.1"
+mkdocstrings-python = { version = "^1.12.1", python = ">3.9,<4" }
 
 [tool.poetry.group.docs-ci]
 optional = true