From 48fffb82cebb03eba55db26112e1f9e0dd60f25f Mon Sep 17 00:00:00 2001
From: profitroll <profitroll@end-play.xyz>
Date: Sun, 5 Jan 2025 22:48:15 +0100
Subject: [PATCH] Added basic files for the Sphinx builder

---
 docs/Makefile    | 20 ++++++++++++++++
 docs/conf.py     | 61 ++++++++++++++++++++++++++++++++++++++++++++++++
 docs/make.bat    | 35 +++++++++++++++++++++++++++
 docs/modules.rst |  7 ++++++
 4 files changed, 123 insertions(+)
 create mode 100644 docs/Makefile
 create mode 100644 docs/conf.py
 create mode 100644 docs/make.bat
 create mode 100644 docs/modules.rst

diff --git a/docs/Makefile b/docs/Makefile
new file mode 100644
index 0000000..d4bb2cb
--- /dev/null
+++ 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/conf.py b/docs/conf.py
new file mode 100644
index 0000000..0196331
--- /dev/null
+++ b/docs/conf.py
@@ -0,0 +1,61 @@
+# 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
+import os
+import sys
+from datetime import datetime
+from typing import List, Dict, Any
+
+import libbot
+
+sys.path.insert(0, os.path.abspath(".."))
+
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project: str = "LibBotUniversal"
+author: str = libbot.__author__
+version: str = libbot.__version__
+release: str = version
+copyright: str = f"{datetime.now().year} {author}"
+
+html_title: str = f"{project} v{version} Documentation"
+
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions: List[str] = [
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.viewcode",
+    "sphinx.ext.napoleon",
+    "sphinx_copybutton",
+]
+
+templates_path: List[str] = ["_templates"]
+exclude_patterns: List[str] = ["_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: str = "furo"
+html_static_path: List[str] = ["_static"]
+
+html_theme_options: Dict[str, Any] = {
+    "source_repository": "https://git.end-play.xyz/profitroll/LibBotUniversal",
+    "source_branch": "main",
+    "source_directory": "docs/",
+    "light_css_variables": {
+        "font-stack": "'Outfit', sans-serif",
+    },
+}
+
+resource_links: Dict[str, Any] = {
+    "issues": "https://git.end-play.xyz/profitroll/LibBotUniversal/issues",
+    "examples": "https://git.end-play.xyz/profitroll/LibBotUniversal/tree/main/examples",
+}
diff --git a/docs/make.bat b/docs/make.bat
new file mode 100644
index 0000000..32bb245
--- /dev/null
+++ b/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
diff --git a/docs/modules.rst b/docs/modules.rst
new file mode 100644
index 0000000..3ab54ed
--- /dev/null
+++ b/docs/modules.rst
@@ -0,0 +1,7 @@
+libbot
+======
+
+.. toctree::
+   :maxdepth: 5
+
+   libbot