Added basics for a proper API docs website

This commit is contained in:
Campbell 2024-06-25 17:34:34 -04:00
parent 75510ed2b9
commit 6575dd37f7
Signed by: NinjaCheetah
GPG Key ID: B547958AF96ED344
9 changed files with 260 additions and 0 deletions

20
docs/Makefile Normal file
View File

@ -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 = source
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)

35
docs/make.bat Normal file
View File

@ -0,0 +1,35 @@
@ECHO OFF
pushd %~dp0
REM Command file for Sphinx documentation
if "%SPHINXBUILD%" == "" (
set SPHINXBUILD=sphinx-build
)
set SOURCEDIR=source
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

BIN
docs/source/banner.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 76 KiB

34
docs/source/conf.py Normal file
View File

@ -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
}

20
docs/source/index.rst Normal file
View File

@ -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`

View File

@ -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:

38
docs/source/libWiiPy.rst Normal file
View File

@ -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:

View File

@ -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:

7
docs/source/modules.rst Normal file
View File

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