Fix docs workflow (#529)

* Fix docs workflow

* Different way of disabling the workflow

Author: Archmonger

.github/workflows/release.yml

@@ -1,5 +1,5 @@
 ---
-name: Publish PyPI Release
+name: Publish PyPI Release (BROKEN)
 
 on:
     release:
@@ -11,26 +11,40 @@ jobs:
 
         steps:
             - uses: actions/checkout@v4
+#             - name: Set up Python
+#               uses: actions/setup-python@v5
+#               with:
+#                   python-version: "3.x"
 
-            - name: Set up Python
-              uses: actions/setup-python@v5
-              with:
-                  python-version: "3.x"
-
-            - name: Install dependencies
-              run: |
-                  python -m pip install -U pip
-                  python -m pip install -r requirements/build.txt
-                  python -m pip install -r requirements.txt
-
-            - name: Build package
-              run: |
-                  python -m build --sdist --wheel --outdir dist .
-                  twine check dist/*
-
-            - name: Upload packages to Jazzband
-              uses: pypa/gh-action-pypi-publish@release/v1
-              with:
-                  user: jazzband
-                  password: ${{ secrets.JAZZBAND_RELEASE_KEY }}
-                  repository-url: https://jazzband.co/projects/django-dbbackup/upload
+#             - name: Install dependencies
+#               run: |
+#                   python -m pip install -U pip
+#                   python -m pip install -U -r requirements/build.txt
+#                   python -m pip install -U -r requirements.txt
+
+#             - name: Build package
+#               run: |
+#                   python -m build --sdist --wheel --outdir dist .
+#                   twine check dist/*
+
+#             - name: Upload packages to Jazzband
+#               uses: pypa/gh-action-pypi-publish@release/v1
+#               with:
+#                   user: jazzband
+#                   password: ${{ secrets.JAZZBAND_RELEASE_KEY }}
+#                   repository-url: https://jazzband.co/projects/django-dbbackup/upload
+
+# This workflopw is disabled due to the following error:
+#
+# ERROR    HTTPError: 500 Internal Server Error from
+#          https://jazzband.co/projects/django-dbbackup/upload
+#          INTERNAL SERVER ERROR
+
+# Until we are transfered out of Jazzband, the workaround is releasing manually via personal PyPI accounts.
+# The following steps are required to release a new version of the package:
+# python -m pip install -U pip
+# python -m pip install -U -r requirements/build.txt
+# python -m pip install -U -r requirements.txt
+# python -m build --sdist --wheel --outdir dist .
+# twine check dist/*
+# twine upload dist/*

.readthedocs.yaml

@@ -0,0 +1,34 @@
+# Read the Docs configuration file for Sphinx projects
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the OS, Python version and other tools you might need
+build:
+    os: ubuntu-22.04
+    tools:
+        python: "3.12"
+        # You can also specify other tool versions:
+        # nodejs: "20"
+        # 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"
+    # 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
+#   - epub
+
+# Optional but recommended, declare the Python requirements required
+# to build your documentation
+# See https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+    install:
+        - requirements: requirements/docs.txt

docs/changelog.rst

@@ -9,8 +9,8 @@ Unreleased
 4.2.0 (2024-08-22)
 ------------------
 
-* Default HOST to localhost for postgres databases. https://github.com/jazzband/django-dbbackup/issues/520
-* Add PostgreSQL Schema support by @angryfoxx in https://github.com/jazzband/django-dbbackup/pull/507
+* Default HOST to localhost for postgres databases.
+* Add PostgreSQL Schema support
 * Fix restore of database from S3 storage by reintroducing inputfile.seek(0) to utils.uncompress_file
 * Add warning for filenames with slashes in them
 * Fix bug where dbbackup management command would not respect settings.py:DBBACKUP_DATABASES

setup.py

@@ -27,6 +27,7 @@ def get_test_requirements():
     author="Archmonger",
     author_email="[email protected]",
     long_description=(root_dir / "README.rst").read_text(encoding="utf-8"),
+    long_description_content_type="text/x-rst",
     python_requires=">=3.7",
     install_requires=get_requirements(),
     tests_require=get_test_requirements(),