Switch documentation from ReadTheDocs/Sphinx to MkDocs Material (#593)

* Replaces the entire Sphinx build system with MkDocs Material theme
* Converts all 9 .rst documentation files to clean Markdown format
* Updates build configurations and dependencies for the new documentation system

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: Archmonger <16909269+Archmonger@users.noreply.github.com>
Co-authored-by: Mark Bakhit <archiethemonger@gmail.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>

Author: 3 people

.gitignore

@@ -58,6 +58,9 @@ coverage_html_report/
 # Sphinx documentation
 docs/_build/
 
+# MkDocs documentation
+site/
+
 # PyBuilder
 target/
 

.readthedocs.yaml

@@ -1,4 +1,4 @@
-# Read the Docs configuration file for Sphinx projects
+# Read the Docs configuration file for MkDocs projects
 # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
 
 # Required
@@ -14,13 +14,12 @@ build:
         # rust: "1.70"
         # golang: "1.20"
 
-# Build documentation in the "docs/" directory with Sphinx
-sphinx:
-    configuration: docs/conf.py
-    # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
-    # builder: "dirhtml"
+# Build documentation with MkDocs
+mkdocs:
+    configuration: mkdocs.yml
     # Fail on all warnings to avoid broken references
     # fail_on_warning: true
+
 # Optionally build your docs in additional formats such as PDF and ePub
 # formats:
 #   - pdf

MANIFEST.in

@@ -1,6 +1,6 @@
 recursive-include requirements *
 include requirements.txt
-include README.rst
+include README.md
 include LICENSE.txt
 include dbbackup/VERSION
 recursive-include dbbackup/tests/testapp/blobs *

README.md

@@ -0,0 +1,24 @@
+# Django Database Backup
+
+[![Build Status](https://github.com/Archmonger/django-dbbackup/actions/workflows/build.yml/badge.svg)](https://github.com/Archmonger/django-dbbackup/actions)
+
+This Django application provides management commands to help backup and restore your project database and media files with various storages such as Amazon S3, Dropbox, local file storage, or any Django-supported storage.
+
+## Features
+
+-   Secure your backup with GPG signature and encryption.
+-   Archive with compression.
+-   Easily manage remote archiving.
+-   Keep your development database up to date.
+-   Set up automated backups with Crontab or Celery.
+-   Manually backup and restore via Django management commands.
+
+## Documentation
+
+For more details, see the [official documentation](https://archmonger.github.io/django-dbbackup/).
+
+## Why use DBBackup?
+
+DBBackup gives you a simple yet robust interface to backup, encrypt, transmit, and restore your database and media.
+
+In a few words, it is a pipe between your Django project and your backups. Behind the hood, your database's standard/best procedure is used to backup and restore data. Optionally, DBBackup can apply compression and/or encryption before transferring the data to nearly any storage system.

README.rst

@@ -1,32 +1,28 @@
-Changelog
-=========
+# Changelog
 
-Unreleased
-----------
+## Unreleased
 
 * Use environment variable for PostgreSQL password to prevent password leakage in logs/emails
 * This repository has been transferred out of Jazzband due to logistical concerns.
 * Drop support for end-of-life Python 3.7 and 3.8.
 * Drop support for end-of-life Django 3.2.
-* Drop support for ``DBBACKUP_STORAGE`` AND  ``DBBACKUP_STORAGE_OPTIONS`` settings, use Django's ``STORAGES['dbbackup']`` setting instead.
-* Implement new ``SqliteBackupConnector`` to backup SQLite3 databases using the ``.backup`` command (safe to execute on DBs with active connections).
+* Drop support for `DBBACKUP_STORAGE` AND  `DBBACKUP_STORAGE_OPTIONS` settings, use Django's `STORAGES['dbbackup']` setting instead.
+* Implement new `SqliteBackupConnector` to backup SQLite3 databases using the `.backup` command (safe to execute on DBs with active connections).
+* Fix encryption support when using `gnupg==5.x`.
 
-4.3.0 (2025-05-09)
-----------
+## 4.3.0 (2025-05-09)
 
 * Add generic `--pg-options` to pass custom options to postgres.
 * Add option `--if-exists` for pg_dump command
 * Empty string as HOST for postgres unix domain socket connection is now supported.
 * Support Python 3.13 and Django 5.2
 
-4.2.1 (2024-08-23)
-----------
+## 4.2.1 (2024-08-23)
 
 * Add --no-drop option to dbrestore command to prevent dropping tables before restoring data.
 * Fix bug where sqlite dbrestore would fail if field data contains the line break character.
 
-4.2.0 (2024-08-22)
-------------------
+## 4.2.0 (2024-08-22)
 
 * Default HOST to localhost for postgres databases.
 * Add PostgreSQL Schema support
@@ -36,8 +32,7 @@ Unreleased
 * Remove usage of deprecated 'get_storage_class' function in newer Django versions
 * Add support for new STORAGES (Django 4.2+) setting under the 'dbbackup' alias
 
-4.1.0 (2024-01-14)
-------------------
+## 4.1.0 (2024-01-14)
 
 * Fix restore fail after editing filename
 * Drop python 3.6
@@ -47,15 +42,13 @@ Unreleased
 * Support Django 4.1, 4.2 and Python 3.11
 * Support Python 3.12 and Django 5.0
 
-4.0.2 (2022-09-27)
-------------------
+## 4.0.2 (2022-09-27)
 
 * support for prometheus wrapped dbs
 * Backup of SQLite fail if there are Virtual Tables (e.g. FTS tables).
 * Closes #460: python-gnupg version increase breaks unencrypt_file func…
 
-4.0.1 (2022-07-09)
----------------------
+## 4.0.1 (2022-07-09)
 
 * As of this version, dbbackup is now within Jazzband! This version tests our Jazzband release CI, and adds miscellaneous refactoring/cleanup.
 * Fix GitHub Actions configuration
@@ -64,8 +57,7 @@ Unreleased
 * Jazzband transfer tasks
 * Refactoring and tooling
 
-4.0.0b0 (2021-12-19)
---------------------
+## 4.0.0b0 (2021-12-19)
 
 * Fix RemovedInDjango41Warning related to default_app_config
 * Add authentication database support for MongoDB
@@ -77,12 +69,10 @@ Unreleased
 * Fix authentication error when postgres is password protected
 * Use exclude-table-data instead of exclude-table
 * Add support for exclude tables data in the command interface
-* Move author and version information into setup.py to allow building package in isolated environment (e.g. with the ``build`` package).
+* Move author and version information into setup.py to allow building package in isolated environment (e.g. with the `build` package).
 * Documentation fixes
 
-
-3.3.0 (2020-04-14)
-------------------
+## 3.3.0 (2020-04-14)
 
 * Documentation fixes
 * "output-filename" in mediabackup command