plun1331 · plun1331 · Mar 17, 2023 · Mar 21, 2023 · Mar 21, 2023 · Mar 21, 2023
diff --git a/.github/workflows/lint.yml b/.github/workflows/lint.yml
@@ -44,4 +44,4 @@ jobs:
           too-few-public-methods,too-many-return-statements,protected-access,too-many-arguments,\
           too-many-branches,too-many-lines,duplicate-code,too-many-statements,too-many-nested-blocks,\
           invalid-name,unused-wildcard-import,wildcard-import,cyclic-import,redefined-builtin,\
-          redefined-outer-name,undefined-variable,import-outside-toplevel
+          redefined-outer-name,undefined-variable,import-outside-toplevel,unused-argument
diff --git a/.gitignore b/.gitignore
@@ -1,4 +1,7 @@
 .devcontainer
 __pycache__
+docs/_build/**
+**.egg-info/**
+dist/**
+docs/changelog.md
 build/**
-**.egg-info/**
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -0,0 +1,16 @@
+version: 2
+build:
+  os: "ubuntu-22.04"
+  tools:
+    python: "3.11"
+
+sphinx:
+  configuration: docs/conf.py
+
+python:
+  install:
+    - method: pip
+      path: .
+      extra_requirements:
+        - docs
+        - microsoft-auth
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,14 +1,15 @@
 # Changelog
 
-All notable changes to this project will be documented in this file.
+All changes to this project will be documented in this file.
 
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and
 this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [Unreleased]
+## [Unreleased](https://github.com/plun1331/minecraft.py/tree/main)
 
 These changes are available on the `main` branch, but have not yet been released.
 
+### Added
 - Implement all play packet classes.
   ([#5](https://github.com/plun1331/minecraft.py/pull/5))
 - Add a `pyproject.toml` file.

diff --git a/LICENSE → LICENSE.md b/LICENSE → LICENSE.md
@@ -1,4 +1,4 @@
-BSD 3-Clause License
+## BSD 3-Clause License
 
 Copyright (c) 2023, plun1331
 

diff --git a/README.md b/README.md
@@ -35,9 +35,12 @@ Note that this requires that you have [`git`](https://git-scm.com/) installed.
 
 
 ### Optional Requirements
-- `microsoft-auth`
+- `microsoft-auth`: Enables the builtin device code authentication flow with `Client.microsoft_auth`.
     - [`msal`](https://pypi.org/project/msal/) for Microsoft authentication
-
+- `docs`: For building the docs locally. Typically not needed unless you plan on contributing.
+    - [`sphinx`](https://pypi.org/project/sphinx/) for documentation generation.
+    - [`furo`](https://pypi.org/project/furo/) for our documentation styling.
+    - [`myst-parser`](https://pypi.org/project/myst-parser/) for parsing markdown files.
 
 ## Support
 

diff --git a/docs/Makefile b/docs/Makefile
@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
diff --git a/docs/api/auth.rst b/docs/api/auth.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: minecraft
+
+Authentication
+===============
+
+.. automodule:: minecraft.auth
+   :members:
diff --git a/docs/api/client.rst b/docs/api/client.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: minecraft
+
+Client
+=======
+
+.. autoclass:: Client
+   :members:
diff --git a/docs/api/datatypes.rst b/docs/api/datatypes.rst
@@ -0,0 +1,9 @@
+.. currentmodule:: minecraft
+
+Data Types
+===========
+
+.. automodule:: minecraft.datatypes
+    :members:
+    :undoc-members: 
+    :show-inheritance:
diff --git a/docs/api/enums.rst b/docs/api/enums.rst
@@ -0,0 +1,8 @@
+.. currentmodule:: minecraft
+
+Enums
+=======
+
+.. automodule:: minecraft.enums
+    :members:
+    :undoc-members:
diff --git a/docs/api/exceptions.rst b/docs/api/exceptions.rst
@@ -0,0 +1,8 @@
+.. currentmodule:: minecraft
+
+Exceptions
+===========
+
+.. automodule:: minecraft.exceptions
+    :members:
+    :show-inheritance:
diff --git a/docs/api/index.rst b/docs/api/index.rst
@@ -0,0 +1,20 @@
+API Reference
+==============
+
+The following section outlines the API of minecraft.py.
+
+.. note:: 
+    The API is still in development and is subject to change.
+
+.. toctree::
+    :maxdepth: 1
+
+    auth
+    client
+    datatypes
+    enums
+    exceptions
+    nbt
+    version
+    networking/index
+    packets/index
diff --git a/docs/api/nbt.rst b/docs/api/nbt.rst
@@ -0,0 +1,17 @@
+.. currentmodule:: nbt.nbt
+
+NBT
+====
+
+.. note::
+    This page contains automatically generated documentation for 
+    the `NBT module <https://github.com/twoolie/NBT>`_, and is not maintained by minecraft.py.
+
+    NBT is licensed under the MIT license, you can view a copy of it 
+    `here <https://github.com/twoolie/NBT/blob/master/LICENSE.txt>`_.
+
+
+.. automodule:: nbt.nbt
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/api/networking/connection.rst b/docs/api/networking/connection.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: minecraft.networking
+
+Connection
+==========
+
+.. autoclass:: Connection
+    :members:
diff --git a/docs/api/networking/dispatcher.rst b/docs/api/networking/dispatcher.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: minecraft.networking
+
+Dispatcher
+==========
+
+.. autoclass:: Dispatcher
+    :members:
diff --git a/docs/api/networking/encryption.rst b/docs/api/networking/encryption.rst
@@ -0,0 +1,7 @@
+.. currentmodule:: minecraft.networking
+
+Encryption
+==========
+
+.. automodule:: minecraft.networking.encryption
+    :members:
diff --git a/docs/api/networking/index.rst b/docs/api/networking/index.rst
@@ -0,0 +1,12 @@
+Networking
+==========
+
+minecraft.py's networking module.
+
+.. toctree::
+    :maxdepth: 1
+
+    connection
+    dispatcher
+    encryption
+    reactors
diff --git a/docs/api/networking/reactors.rst b/docs/api/networking/reactors.rst
@@ -0,0 +1,37 @@
+.. currentmodule:: minecraft.networking.reactors
+
+Reactors
+=========
+
+A reactor is a class used by the :class:`.Connection` to handle incoming packets, 
+while also forcing the read loop to wait until processing of the packet is complete.
+
+This is useful in cases like :class:`.SetCompression`, in which the next packet will be compressed,
+and the :class:`.Connection` needs to know that before recieving it.
+
+These are mostly used by the library and shouldn't need to be overriden by you, the developer, 
+however, you can still override their default behavior by updating :data:`REACTORS` with your own :class:`Reactor`.
+
+.. data:: REACTORS
+
+    A dictionary mapping connection states to reactors. (:class:`dict`\[:class:`.State`, :class:`Reactor`\])
+
+.. autoclass:: Reactor
+    :members:
+
+.. autofunction:: react_to
+
+Login
+---------
+
+.. autoclass:: LoginReactor
+    :members:
+    :undoc-members:
+
+
+Play
+---------
+
+.. autoclass:: PlayReactor
+    :members:
+    :undoc-members:
diff --git a/docs/api/packets/handshake.rst b/docs/api/packets/handshake.rst
@@ -0,0 +1,17 @@
+Handshake
+=========
+
+Clientbound
+-----------
+
+There are no client bound packets for the handshake state. After :class:`Handshake` is sent, 
+the state immediately switches to :attr:`.State.LOGIN`.
+
+
+Serverbound
+-----------
+
+.. automodule:: minecraft.packets.handshake_serverbound
+    :members:
+    :member-order: bysource
+
diff --git a/docs/api/packets/index.rst b/docs/api/packets/index.rst
@@ -0,0 +1,34 @@
+Packets
+=======
+
+Every packet in the Minecraft protocol is implemented here.
+
+All packets inherit from one base class, :class:`.Packet`.
+
+.. toctree::
+    :maxdepth: 1
+
+    handshake
+    login
+    status
+    play
+
+
+Packet
+------
+
+.. currentmodule:: minecraft.packets
+
+.. autoclass:: Packet
+    :members:
+
+    .. autoattribute:: packet_id
+        :annotation: = The packet's ID
+
+    .. autoattribute:: state
+        :annotation: = The state the packet is used in
+
+    .. autoattribute:: bound_to
+        :annotation: = The direction the packet is sent in
+
+.. autofunction:: get_packet
diff --git a/docs/api/packets/login.rst b/docs/api/packets/login.rst
@@ -0,0 +1,18 @@
+Login
+======
+
+Clientbound
+-----------
+
+.. automodule:: minecraft.packets.login_clientbound
+    :members:
+    :member-order: bysource
+
+
+Serverbound
+-----------
+
+.. automodule:: minecraft.packets.login_serverbound
+    :members:
+    :member-order: bysource
+
diff --git a/docs/api/packets/play.rst b/docs/api/packets/play.rst
@@ -0,0 +1,18 @@
+Play
+====
+
+Clientbound
+-----------
+
+.. automodule:: minecraft.packets.play_clientbound
+    :members:
+    :member-order: bysource
+
+
+Serverbound
+-----------
+
+.. automodule:: minecraft.packets.play_serverbound
+    :members:
+    :member-order: bysource
+
diff --git a/docs/api/packets/status.rst b/docs/api/packets/status.rst
@@ -0,0 +1,18 @@
+Status
+======
+
+Clientbound
+-----------
+
+.. automodule:: minecraft.packets.status_clientbound
+    :members:
+    :member-order: bysource
+
+
+Serverbound
+-----------
+
+.. automodule:: minecraft.packets.status_serverbound
+    :members:
+    :member-order: bysource
+
diff --git a/docs/api/version.rst b/docs/api/version.rst
@@ -0,0 +1,21 @@
+.. currentmodule:: minecraft
+
+Versioning
+==========
+
+This project adheres to `Semantic Versioning <https://semver.org/spec/v2.0.0.html>`_.
+
+.. data:: __version__
+
+   The current version of the library, such as ``'0.0.0-alpha.1'``.
+
+   :type: str
+
+
+.. data:: version_info
+
+    The current version of the library in a named tuple.
+
+    This is identical to :data:`sys.version_info`.
+
+    :type: typing.NamedTuple