Demolish sphinx

hikari-py · Jan 20, 2024 · 9405f96 · 9405f96
1 parent 73bc635
commit 9405f96
Show file tree

Hide file tree

Showing 18 changed files with 312 additions and 469 deletions.
diff --git a/.gitignore b/.gitignore
@@ -64,4 +64,9 @@ prof/
 # Logs
 *.log
 
+# Generated docs
+reference/
+site/
+.cache/
+
 Pipfile*
diff --git a/.readthedocs.yaml b/.readthedocs.yaml
@@ -3,26 +3,14 @@ version: 2
 build:
   os: ubuntu-22.04
   tools:
-    python: "3.9"
+    python: "3.11"
 
-sphinx:
-  configuration: docs/conf.py
-  builder: dirhtml
+mkdocs:
+  configuration: mkdocs.yml
 
 python:
    install:
-     - requirements: dev-requirements/sphinx.txt
+     - requirements: dev-requirements/mkdocs.txt
      - method: pip
        path: .
 
-search:
-  ignore:
-    # Defaults
-    - search.html
-    - search/index.html
-    - 404.html
-    - 404/index.html
-
-    # Custom
-    - index.html
-    - changelog/index.html
diff --git a/README.md b/README.md
@@ -35,6 +35,7 @@ py -3 -m pip install -U hikari
 ## Bots
 
 Hikari provides two different default bot implementations to suit your needs:
+
 - [GatewayBot](#gatewaybot)
 - [RESTBot](#restbot)
 
@@ -194,6 +195,7 @@ bot.run(
 
 Many other helpful options exist for you to take advantage of if you wish. Links to the respective docs can be seen
 below:
+
 - [GatewayBot.run](https://docs.hikari-py.dev/en/stable/reference/hikari/impl/gateway_bot/#hikari.impl.gateway_bot.GatewayBot.run)
 - [RESTBot.run](https://docs.hikari-py.dev/en/stable/reference/hikari/impl/rest_bot/#hikari.impl.rest_bot.RESTBot.run)
 
@@ -251,9 +253,10 @@ implementing your own command handler.
 
 Hikari does not include a command framework by default, so you will want to pick a third party library to do it:
 
+- [`arc`](https://github.com/hypergonial/hikari-arc) - a bot framework with with a focus on type-safety and correctness.
+- [`crescent`](https://github.com/magpie-dev/hikari-crescent) - a command handler for Hikari that keeps your project neat and tidy.
 - [`lightbulb`](https://github.com/tandemdude/hikari-lightbulb) - a simple and easy to use command framework for Hikari.
 - [`tanjun`](https://github.com/FasterSpeeding/Tanjun) - a flexible command framework designed to extend Hikari.
-- [`crescent`](https://github.com/magpie-dev/hikari-crescent) - a command handler for Hikari that keeps your project neat and tidy.
 
 ---
 

diff --git a/dev-requirements/mkdocs.txt b/dev-requirements/mkdocs.txt
@@ -0,0 +1,21 @@
+# Mkdocs Material
+mkdocs-material[imaging]==9.5.4
+
+# Docstring parsing for API reference
+mkdocstrings-python==1.8.0
+griffe-inherited-docstrings==1.0.0
+
+# Generate API reference pages dynamically
+mkdocs-gen-files==0.5.0
+
+# SUMMARY.md support
+mkdocs-literate-nav==0.6.1
+
+# Treat index.md as section top
+mkdocs-section-index==0.3.8
+
+# Formatting signatures
+black==23.12.1
+
+# Image viewer ext
+mkdocs-glightbox==0.3.6
diff --git a/dev-requirements/sphinx.txt b/dev-requirements/sphinx.txt
diff --git a/docs/_static/extra.css b/docs/_static/extra.css
diff --git a/docs/_templates/numpydoc_docstring.rst b/docs/_templates/numpydoc_docstring.rst
diff --git a/docs/_templates/python/module.rst b/docs/_templates/python/module.rst
diff --git a/docs/assets/hikari_logo.png b/docs/assets/hikari_logo.png
diff --git a/docs/changelog.md b/docs/changelog.md
@@ -0,0 +1,12 @@
+---
+title: Changelog
+description: Learn what the latest changes are!
+hide:
+  - navigation
+---
+
+!!! warning
+    Major and minor releases also include the changes specified in prior development releases.
+
+
+--8<-- "CHANGELOG.md"
diff --git a/docs/changelog/index.md b/docs/changelog/index.md