Added basics for a proper API docs website

docs/source/conf.py

@@ -0,0 +1,34 @@
+# 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
+
+project = 'libWiiPy'
+copyright = '2024, NinjaCheetah & Contributors'
+author = 'NinjaCheetah & Contributors'
+release = '0.4.0'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['myst_parser', 'sphinx.ext.napoleon']
+
+templates_path = ['_templates']
+exclude_patterns = []
+
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'sphinx_book_theme'
+html_static_path = ['_static']
+html_logo = "banner.png"
+html_title = "libWiiPy API Docs"
+html_theme_options = {
+    "repository_url": "https://github.com/NinjaCheetah/libWiiPy",
+    "use_repository_button": True
+}

docs/source/index.rst

@@ -0,0 +1,20 @@
+.. 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.rst

@@ -0,0 +1,29 @@
+libWiiPy.archive package
+========================
+
+Submodules
+----------
+
+libWiiPy.archive.ash module
+---------------------------
+
+.. automodule:: libWiiPy.archive.ash
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+libWiiPy.archive.u8 module
+--------------------------
+
+.. automodule:: libWiiPy.archive.u8
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: libWiiPy.archive
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/libWiiPy.rst

@@ -0,0 +1,38 @@
+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.rst

@@ -0,0 +1,77 @@
+libWiiPy.title package
+======================
+
+Submodules
+----------
+
+libWiiPy.title.commonkeys module
+--------------------------------
+
+.. automodule:: libWiiPy.title.commonkeys
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+libWiiPy.title.content module
+-----------------------------
+
+.. automodule:: libWiiPy.title.content
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+libWiiPy.title.crypto module
+----------------------------
+
+.. automodule:: libWiiPy.title.crypto
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+libWiiPy.title.nus module
+-------------------------
+
+.. automodule:: libWiiPy.title.nus
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+libWiiPy.title.ticket module
+----------------------------
+
+.. automodule:: libWiiPy.title.ticket
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+libWiiPy.title.title module
+---------------------------
+
+.. automodule:: libWiiPy.title.title
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+libWiiPy.title.tmd module
+-------------------------
+
+.. automodule:: libWiiPy.title.tmd
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+libWiiPy.title.wad module
+-------------------------
+
+.. automodule:: libWiiPy.title.wad
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
+Module contents
+---------------
+
+.. automodule:: libWiiPy.title
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/source/modules.rst

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