diff --git a/docs/source/api.md b/docs/source/api.md index 6a25d25..cb4df87 100644 --- a/docs/source/api.md +++ b/docs/source/api.md @@ -9,10 +9,12 @@ libWiiPy is divided up into a few subpackages to organize related features. | [libWiiPy.nand](/nand/nand) | Used for working with EmuNANDs and core system files on the Wii | | [libWiiPy.title](/title/title) | Used for parsing and manipulating Wii titles | +When using libWiiPy in your project, you can choose to either only import the package that you need, or you can use `import libWiiPy` to import the entire package, which each module being available at `libWiiPy..`. + ## Full Package Contents ```{toctree} -:maxdepth: 4 +:maxdepth: 8 /archive/archive /media/media diff --git a/docs/source/archive/ash.md b/docs/source/archive/ash.md index 56d8819..2af9257 100644 --- a/docs/source/archive/ash.md +++ b/docs/source/archive/ash.md @@ -1,5 +1,9 @@ # libWiiPy.archive.ash Module +The `libWiiPy.archive.ash` module provides support for handling ASH files, which are a compressed format primarily used in the Wii Menu, but also in some other titles such as My Pokémon Ranch. + +At present, libWiiPy only has support for decompressing ASH files, with compression as a planned feature for the future. + ## Module Contents ```{eval-rst} diff --git a/docs/source/archive/u8.md b/docs/source/archive/u8.md index 1417296..ea916f3 100644 --- a/docs/source/archive/u8.md +++ b/docs/source/archive/u8.md @@ -1,5 +1,9 @@ # libWiiPy.archive.u8 Module +The `libWiiPy.archive.u8` module provides support for handling U8 archives, which are a non-compressed archive format used extensively on the Wii to join multiple files into one. + +This module exposes functions for both packing and unpacking U8 archives, as well as code to parse IMET headers. IMET headers are a header format used specifically for U8 archives containing the banner of a channel, as they store the localized name of the channel along with other banner metadata. + ## Module Contents ```{eval-rst} diff --git a/docs/source/media/banner.md b/docs/source/media/banner.md index 684b0db..a67b0e4 100644 --- a/docs/source/media/banner.md +++ b/docs/source/media/banner.md @@ -1,5 +1,7 @@ # libWiiPy.media.banner Module +The `libWiiPy.media.banner` module is essentially a stub at this point in time. It only provides one dataclass that is likely to become a traditional class when fully implemented. It is not recommended to use this module for anything yet. + ## Module Contents ```{eval-rst} diff --git a/docs/source/nand/emunand.md b/docs/source/nand/emunand.md index 3b85d51..ea425ac 100644 --- a/docs/source/nand/emunand.md +++ b/docs/source/nand/emunand.md @@ -1,5 +1,7 @@ # libWiiPy.nand.emunand Module +The `libWiiPy.nand.emunand` module provides support for creating and managing Wii EmuNANDs. At present, you cannot create an EmuNAND compatible with something like NEEK on a real Wii with the features provided by this library, but you can create an EmuNAND compatible with Dolphin. + ## Module Contents ```{eval-rst}