chore: replace RST with markdown, remove docs-lint and readthedocs config

.github/workflows/lint.yml

@@ -13,7 +13,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        toxenv: [lint, docs-lint, pycodestyle]
+        toxenv: [lint, pycodestyle]
         python-version: [ "3.12" ]
         include:
           # for actions that want git env, not tox env

.readthedocs.yaml

@@ -1,22 +0,0 @@
-# .readthedocs.yaml
-# Read the Docs configuration file
-# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
-
-# Required
-version: 2
-
-# Set the version of Python and other tools you might need
-build:
-  os: ubuntu-22.04
-  tools:
-    python: "3.11"
-
-# Build documentation in the docs/ directory with Sphinx
-sphinx:
-  configuration: docs/source/conf.py
-
-# We recommend specifying your dependencies to enable reproducible builds:
-# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
-# python:
-#   install:
-#   - requirements: docs/requirements.txt

MANIFEST.in

@@ -1,7 +1,7 @@
 include .gitignore
 include LICENSE
 include NOTICE
-include README.rst
+include README.md
 include THANKS
 include requirements_dev.txt
 include requirements_test.txt

appveyor.yml

@@ -3,8 +3,6 @@ environment:
   matrix:
     - TOXENV: lint
       PYTHON: "C:\\Python312-x64"
-    - TOXENV: docs-lint
-      PYTHON: "C:\\Python312-x64"
     - TOXENV: pycodestyle
       PYTHON: "C:\\Python312-x64"
     # Windows cannot even import the module when they unconditionally import, see below.

docker/Dockerfile

@@ -10,7 +10,7 @@ RUN useradd --create-home --shell /bin/bash gunicorn
 WORKDIR /app
 
 # Install gunicorn from source
-COPY pyproject.toml README.rst LICENSE ./
+COPY pyproject.toml README.md LICENSE ./
 COPY gunicorn/ ./gunicorn/
 RUN pip install --no-cache-dir .
 

docs/README.md

@@ -0,0 +1,27 @@
+# Generate Documentation
+
+## Requirements
+
+Install the documentation dependencies with:
+
+```bash
+pip install -r requirements_dev.txt
+```
+
+This provides MkDocs with the Material theme and supporting plugins.
+
+## Build static HTML
+
+```bash
+mkdocs build
+```
+
+The rendered site is emitted into the `site/` directory.
+
+## Preview locally
+
+```bash
+mkdocs serve
+```
+
+This serves the documentation at http://127.0.0.1:8000/ with live reload.

docs/README.rst

@@ -1,29 +0,0 @@
-Generate Documentation
-======================
-
-Requirements
-------------
-
-Install the documentation dependencies with::
-
-    pip install -r requirements_dev.txt
-
-This provides MkDocs with the Material theme and supporting plugins.
-
-
-Build static HTML
------------------
-::
-
-    mkdocs build
-
-The rendered site is emitted into the ``site/`` directory.
-
-
-Preview locally
----------------
-::
-
-    mkdocs serve
-
-This serves the documentation at http://127.0.0.1:8000/ with live reload.

tox.ini

@@ -2,7 +2,6 @@
 envlist =
   py{312,313},
   lint,
-  docs-lint,
   pycodestyle,
   run-entrypoint,
   run-module,
@@ -47,14 +46,6 @@ commands =
 deps =
   pylint==3.3.2
 
-[testenv:docs-lint]
-no_package = true
-deps =
-  restructuredtext_lint
-  pygments
-commands =
-  rst-lint README.rst docs/README.rst
-
 [testenv:pycodestyle]
 no_package = true
 commands =