Rewrote all docs in Markdown instead of the default reST

docs/source/index.md

@@ -0,0 +1,15 @@
+# libWiiPy API Docs
+
+```{toctree}
+:maxdepth: 2
+:caption: Contents:
+```
+
+Welcome to the API documentation website for libWiiPy! libWiiPy is a modern Python 3 library for handling the various files and formats found on the Wii.
+
+
+## Indices and tables
+
+* [Full Index](<project:#genindex>)
+* [Module Index](<project:#modules>)
+* <project:#search>

docs/source/index.rst

@@ -1,20 +0,0 @@
-.. libWiiPy documentation master file, created by
-   sphinx-quickstart on Tue Jun 25 17:09:58 2024.
-   You can adapt this file completely to your liking, but it should at least
-   contain the root `toctree` directive.
-
-Welcome to libWiiPy's documentation!
-====================================
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-
-
-Indices and tables
-==================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`

docs/source/libWiiPy.archive.md

@@ -1,29 +1,28 @@
-libWiiPy.archive package
-========================
+# libWiiPy.archive package
 
-Submodules
-----------
+## Submodules
 
-libWiiPy.archive.ash module
----------------------------
+### libWiiPy.archive.ash module
 
+```{eval-rst}
 .. automodule:: libWiiPy.archive.ash
    :members:
    :undoc-members:
    :show-inheritance:
+```
+### libWiiPy.archive.u8 module
 
-libWiiPy.archive.u8 module
---------------------------
-
+```{eval-rst}
 .. automodule:: libWiiPy.archive.u8
    :members:
    :undoc-members:
    :show-inheritance:
+```
+## Module contents
 
-Module contents
----------------
-
+```{eval-rst}
 .. automodule:: libWiiPy.archive
    :members:
    :undoc-members:
    :show-inheritance:
+```

docs/source/libWiiPy.md

@@ -0,0 +1,34 @@
+# libWiiPy package
+
+## Subpackages
+
+```{toctree}
+:maxdepth: 4
+
+libWiiPy.archive
+libWiiPy.title
+```
+
+## Submodules
+
+### libWiiPy.shared module
+
+libWiiPy's ``shared`` module is private and contains only private functions used by other modules.
+
+```{eval-rst}
+.. automodule:: libWiiPy.shared
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```
+
+### libWiiPy.types module
+
+libWiiPy's ``types`` module is private and contains only private classes used by other modules.
+
+```{eval-rst}
+.. automodule:: libWiiPy.types
+   :members:
+   :undoc-members:
+   :show-inheritance:
+```

docs/source/libWiiPy.rst

@@ -1,38 +0,0 @@
-libWiiPy package
-================
-
-Subpackages
------------
-
-.. toctree::
-   :maxdepth: 4
-
-   libWiiPy.archive
-   libWiiPy.title
-
-Submodules
-----------
-
-libWiiPy.shared module
-----------------------
-
-.. automodule:: libWiiPy.shared
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-libWiiPy.types module
----------------------
-
-.. automodule:: libWiiPy.types
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-Module contents
----------------
-
-.. automodule:: libWiiPy
-   :members:
-   :undoc-members:
-   :show-inheritance:

docs/source/libWiiPy.title.md

@@ -1,77 +1,78 @@
-libWiiPy.title package
-======================
+# libWiiPy.title package
 
-Submodules
-----------
+## Submodules
 
-libWiiPy.title.commonkeys module
---------------------------------
+### libWiiPy.title.commonkeys module
 
+```{eval-rst}
 .. automodule:: libWiiPy.title.commonkeys
    :members:
    :undoc-members:
    :show-inheritance:
+```
 
-libWiiPy.title.content module
------------------------------
+### libWiiPy.title.content module
 
+```{eval-rst}
 .. automodule:: libWiiPy.title.content
    :members:
    :undoc-members:
    :show-inheritance:
+```
 
-libWiiPy.title.crypto module
-----------------------------
+### libWiiPy.title.crypto module
 
+```{eval-rst}
 .. automodule:: libWiiPy.title.crypto
    :members:
    :undoc-members:
    :show-inheritance:
+```
+### libWiiPy.title.nus module
 
-libWiiPy.title.nus module
--------------------------
-
+```{eval-rst}
 .. automodule:: libWiiPy.title.nus
    :members:
    :undoc-members:
    :show-inheritance:
+```
+### libWiiPy.title.ticket module
 
-libWiiPy.title.ticket module
-----------------------------
-
+```{eval-rst}
 .. automodule:: libWiiPy.title.ticket
    :members:
    :undoc-members:
    :show-inheritance:
+```
+### libWiiPy.title.title module
 
-libWiiPy.title.title module
----------------------------
-
+```{eval-rst}
 .. automodule:: libWiiPy.title.title
    :members:
    :undoc-members:
    :show-inheritance:
+```
+### libWiiPy.title.tmd module
 
-libWiiPy.title.tmd module
--------------------------
-
+```{eval-rst}
 .. automodule:: libWiiPy.title.tmd
    :members:
    :undoc-members:
    :show-inheritance:
+```
+### libWiiPy.title.wad module
 
-libWiiPy.title.wad module
--------------------------
-
+```{eval-rst}
 .. automodule:: libWiiPy.title.wad
    :members:
    :undoc-members:
    :show-inheritance:
+```
+## Module contents
 
-Module contents
----------------
-
+```{eval-rst}
 .. automodule:: libWiiPy.title
    :members:
    :undoc-members:
    :show-inheritance:
+```

docs/source/modules.md

@@ -0,0 +1,7 @@
+# libWiiPy
+
+```{toctree}
+:maxdepth: 4
+
+libWiiPy
+```

docs/source/modules.rst

@@ -1,7 +0,0 @@
-libWiiPy
-========
-
-.. toctree::
-   :maxdepth: 4
-
-   libWiiPy