docs: generate docs with sphinx and furo (#2)

* Add docs

* Create .readthedocs.yaml

* Add requirements

* Add logo

* Add errors to doc

* Configure settings and add custom session

* Add docs URL

* Change dev status

.pre-commit-config.yaml

@@ -26,7 +26,7 @@ repos:
     rev: v1.10.0
     hooks:
       - id: mypy
-        args: [--disable-error-code=union-attr]
+        args: [--disable-error-code=union-attr, --disable-error-code=import]
 
   - repo: https://github.com/asottile/pyupgrade
     rev: v3.15.2

.readthedocs.yaml

@@ -0,0 +1,18 @@
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+version: 2
+
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.11"
+
+sphinx:
+   configuration: docs/conf.py
+   fail_on_warning: false
+   builder: html
+
+python:
+   install:
+   - requirements: docs/requirements.txt

cookiebot/api.py

@@ -16,16 +16,18 @@ def _stats_dict(data: dict[str, int]) -> dict[date, int]:
 
 
 class CookieAPI:
-    """A class to interact with the Cookie Bot API.
+    """A class to interact with the CookieBot API.
 
     Parameters
     ----------
     api_key:
         The API key to use. If no key is provided, ``COOKIE_KEY`` is loaded from the environment.
+    session:
+        An existing aiohttp session to use.
     """
 
-    def __init__(self, api_key: str | None = None):
-        self._session: aiohttp.ClientSession | None = None
+    def __init__(self, api_key: str | None = None, session: aiohttp.ClientSession | None = None):
+        self._session: aiohttp.ClientSession | None = session
 
         if api_key is None:
             load_dotenv()
@@ -48,6 +50,10 @@ async def _setup(self):
             self._session = aiohttp.ClientSession()
 
     async def close(self):
+        """Close the aiohttp session. When using the async context manager,
+        this is called automatically.
+        """
+
         await self._session.close()
 
     @overload

cookiebot/errors.py

@@ -1,26 +1,40 @@
 class CookieError(Exception):
+    """Base exception class for all CookieBot exceptions."""
+
     pass
 
 
 class InvalidAPIKey(CookieError):
+    """Raised when an invalid API key is provided or if no key was found
+    in the environment variables.
+    """
+
     def __init__(self, msg: str | None = None):
         super().__init__(msg or "Invalid API key.")
 
 
 class NotFound(CookieError):
+    """Raised when an object is not found."""
+
     pass
 
 
 class UserNotFound(NotFound):
+    """Raised when the given user ID is not found."""
+
     def __init__(self):
         super().__init__("Could not find the user ID.")
 
 
 class GuildNotFound(NotFound):
+    """Raised when the given guild ID is not found."""
+
     def __init__(self):
         super().__init__("Could not find the guild ID.")
 
 
 class NoGuildAccess(CookieError):
+    """Raised when you do not have access to a guild."""
+
     def __init__(self):
         super().__init__("You are not a member of this guild.")

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)

docs/conf.py

@@ -0,0 +1,54 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+import os
+import sys
+from datetime import date
+
+sys.path.insert(0, os.path.abspath("../"))
+
+from cookiebot import __version__
+
+project = "CookieBot"
+copyright = f"{date.today().year}, tibue99"
+author = "tibue99"
+release = __version__
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.intersphinx",
+    "sphinx_copybutton",
+    "sphinx_autodoc_typehints",
+    "myst_parser",
+]
+
+simplify_optional_unions = True
+autodoc_member_order = "bysource"
+
+intersphinx_mapping = {
+    "py": ("https://docs.python.org/3", None),
+    "aio": ("https://docs.aiohttp.org/", None),
+}
+
+templates_path = ["_templates"]
+exclude_patterns = ["_build", "Thumbs.db", ".DS_Store"]
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = "furo"
+html_static_path = ["_static"]
+
+html_title = f"<h3 align='center'>{release}</h3>"
+html_logo = "_static/logo.png"
+html_favicon = "_static/favicon.ico"

docs/cookiebot/api.rst

@@ -0,0 +1,6 @@
+API
+=======================
+
+.. autoclass:: cookiebot.CookieAPI
+   :members:
+   :undoc-members:

docs/cookiebot/errors.rst

@@ -0,0 +1,6 @@
+Errors
+=======================
+
+.. automodule:: cookiebot.errors
+   :members:
+   :undoc-members:

docs/cookiebot/models.rst

@@ -0,0 +1,6 @@
+Models
+=======================
+
+.. automodule:: cookiebot.models
+   :members:
+   :undoc-members:

docs/index.rst

@@ -0,0 +1,12 @@
+.. include:: ../README.md
+   :parser: myst_parser.sphinx_
+
+
+.. toctree::
+   :maxdepth: 2
+   :hidden:
+   :caption: Contents:
+
+   cookiebot/api
+   cookiebot/models
+   cookiebot/errors

docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

docs/requirements.txt

@@ -0,0 +1,7 @@
+sphinx
+furo
+sphinx-autodoc-typehints
+sphinx-copybutton
+myst-parser
+aiohttp
+python-dotenv

pyproject.toml

@@ -9,7 +9,7 @@ authors = [
     { name = "tibue99" }, { name="tobfd" }
 ]
 classifiers = [
-    "Development Status :: 4 - Beta",
+    "Development Status :: 5 - Production/Stable",
     "License :: OSI Approved :: MIT License",
     "Intended Audience :: Developers",
     "Operating System :: OS Independent",
@@ -27,6 +27,7 @@ dependencies = {file = "requirements.txt"}
 [project.urls]
 GitHub = "https://github.com/tibue99/cookie-api"
 CookieBot = "https://cookie-bot.xyz"
+Documentation = "https://cookiebot.readthedocs.io"
 
 [build-system]
 requires = ["setuptools>=61.0"]