Migrate to mkdocs (#99)

* Initial mkdocs work
Metron-Project · Jun 17, 2024 · 107a4ac · 107a4ac
1 parent 5cf3d5e
commit 107a4ac
Show file tree

Hide file tree

Showing 25 changed files with 594 additions and 490 deletions.
diff --git a/.readthedocs.yml b/.readthedocs.yml
@@ -17,5 +17,5 @@ build:
       - poetry install --with docs
 
 # Build documentation in the "docs/" directory with Sphinx
-sphinx:
-  configuration: docs/source/conf.py
+mkdocs:
+  configuration: mkdocs.yaml
diff --git a/README.md b/README.md
@@ -0,0 +1,26 @@
+# Darkseid
+
+[![PyPI - Version](https://img.shields.io/pypi/v/darkseid.svg)](https://pypi.org/project/darkseid/)
+[![PyPI - Python](https://img.shields.io/pypi/pyversions/darkseid.svg)](https://pypi.org/project/darkseid/)
+[![Ruff](https://img.shields.io/badge/Linter-Ruff-informational)](https://github.com/charliermarsh/ruff)
+[![Pre-Commit](https://img.shields.io/badge/Pre--Commit-Enabled-informational?logo=pre-commit)](https://github.com/pre-commit/pre-commit)
+
+A [Python](https://www.python.org/) library to interact with comic archives.
+
+## Installation
+
+```bash
+pipx install darkeid
+```
+or
+```bash
+pip install darkeid
+```
+
+## Documentation
+
+[Read the project documentation](https://darkseid.readthedocs.io/en/latest/?badge=latest)
+
+## Bugs/Requests
+
+Please use the [GitHub issue tracker](https://github.com/Metron-Project/darkseid/issues) to submit bugs or request features.
diff --git a/README.rst b/README.rst
diff --git a/darkseid/archivers/archiver.py b/darkseid/archivers/archiver.py
@@ -37,7 +37,7 @@ def read_file(self: Archiver, archive_file: str) -> bytes:
             bytes: The content of the file as bytes.
 
         Raises:
-            NotImplementedError
+            NotImplementedError: Method or function hasn't been implemented yet.
         """
 
         raise NotImplementedError

diff --git a/docs/Makefile b/docs/Makefile
diff --git a/docs/darkseid/archivers/__init__.md b/docs/darkseid/archivers/__init__.md
@@ -0,0 +1 @@
+:::darkseid.archivers.UnknownArchiver
diff --git a/docs/darkseid/archivers/archiver.md b/docs/darkseid/archivers/archiver.md
@@ -0,0 +1 @@
+:::darkseid.archivers.Archiver
diff --git a/docs/darkseid/archivers/rar.md b/docs/darkseid/archivers/rar.md
@@ -0,0 +1 @@
+:::darkseid.archivers.RarArchiver
diff --git a/docs/darkseid/archivers/zip.md b/docs/darkseid/archivers/zip.md
@@ -0,0 +1 @@
+:::darkseid.archivers.ZipArchiver
diff --git a/docs/darkseid/comic.md b/docs/darkseid/comic.md
@@ -0,0 +1 @@
+:::darkseid.comic.Comic
diff --git a/docs/darkseid/comicinfo.md b/docs/darkseid/comicinfo.md
@@ -0,0 +1 @@
+:::darkseid.comicinfo.ComicInfo
diff --git a/docs/darkseid/exceptions.md b/docs/darkseid/exceptions.md
@@ -0,0 +1 @@
+:::darkseid.exceptions.RarError
diff --git a/docs/darkseid/issue_string.md b/docs/darkseid/issue_string.md
@@ -0,0 +1 @@
+:::darkseid.issue_string.IssueString
diff --git a/docs/darkseid/metadata.md b/docs/darkseid/metadata.md
@@ -0,0 +1,12 @@
+:::darkseid.metadata.Validations
+:::darkseid.metadata.PageType
+:::darkseid.metadata.ImageMetadata
+:::darkseid.metadata.Price
+:::darkseid.metadata.Basic
+:::darkseid.metadata.Universe
+:::darkseid.metadata.Role
+:::darkseid.metadata.Series
+:::darkseid.metadata.Arc
+:::darkseid.metadata.Credit
+:::darkseid.metadata.GTIN
+:::darkseid.metadata.Metadata
diff --git a/docs/darkseid/utils.md b/docs/darkseid/utils.md
@@ -0,0 +1,5 @@
+:::darkseid.utils.get_recursive_filelist
+:::darkseid.utils.list_to_string
+:::darkseid.utils.remove_articles
+:::darkseid.utils.unique_file
+:::darkseid.utils.xlate
diff --git a/docs/index.md b/docs/index.md
@@ -0,0 +1 @@
+{% include-markdown "../README.md" %}
diff --git a/docs/make.bat b/docs/make.bat
diff --git a/docs/source/__init__.py b/docs/source/__init__.py
diff --git a/docs/source/conf.py b/docs/source/conf.py
diff --git a/docs/source/darkseid.rst b/docs/source/darkseid.rst
diff --git a/docs/source/index.rst b/docs/source/index.rst
diff --git a/docs/source/modules.rst b/docs/source/modules.rst