Switch doc to Markdown

ewjoachim · ewjoachim · commit 77804f18be1a · 2024-01-20T17:10:55.000+01:00
diff --git a/.editorconfig b/.editorconfig
@@ -14,7 +14,7 @@ charset = utf-8
 quote_type = double
 max_line_length = 88
 
-[*.rst]
+[*.md]
 max_line_length = 88
 
 [*.yml]
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -2,7 +2,7 @@ Closes #<ticket number>
 
 <!-- Please do not remove this, even if you think you don't need it -->
 ### Successful PR Checklist:
-<!-- In case of doubt, we're here to help. CONTRIBUTING.rst might help too -->
+<!-- In case of doubt, we're here to help. CONTRIBUTING.md might help too -->
 - [ ] Tests
   - [ ] (not applicable?)
 - [ ] Documentation
diff --git a/docs/conf.py b/docs/conf.py
@@ -33,6 +33,7 @@
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
 extensions = [
+    "myst_parser",
     "sphinx.ext.napoleon",
     "sphinx.ext.autodoc",
     "sphinx_autodoc_typehints",
@@ -41,6 +42,12 @@
     "sphinx_copybutton",
 ]
 
+myst_enable_extensions = [
+    "colon_fence",
+    "deflist",
+    "tasklist",
+]
+
 set_type_checking_flag = True
 
 # Add any paths that contain templates here, relative to this directory.
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -13,7 +13,7 @@ classifiers = [
     "Intended Audience :: Developers",
     "License :: OSI Approved :: MIT License",
 ]
-readme = "README.rst"
+readme = "README.md"
 keywords = ["postgres", "task-queue"]
 homepage = "https://procrastinate.readthedocs.io/"
 repository = "https://github.com/procrastinate-org/procrastinate/"
@@ -80,6 +80,7 @@ sphinx-autodoc-typehints = "*"
 sphinx-copybutton = "*"
 sphinx-github-changelog = "*"
 sphinxcontrib-programoutput = "*"
+myst-parser = "*"
 
 [tool.poetry-dynamic-versioning]
 enable = true
diff --git a/scripts/README.md b/scripts/README.md
@@ -5,4 +5,4 @@ for the project.
 
 These scripts are expected to be run as-is, not in poetry or a virtualenv.
 
-See [CONTRIBUTING.rst](../CONTRIBUTING.rst) for more details.
+See [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.
diff --git a/scripts/docs b/scripts/docs
@@ -1,4 +1,4 @@
 #!/usr/bin/env bash
 set -eux
 
-poetry run sphinx-build -EW docs docs/_build/html "$@"
+poetry run sphinx-build -E docs docs/_build/html "$@"

Original file line number	Diff line number	Diff line change
`@@ -5,4 +5,4 @@ for the project.`
`5`	`5`
`6`	`6`	`These scripts are expected to be run as-is, not in poetry or a virtualenv.`
`7`	`7`
`8`		`-See [CONTRIBUTING.rst](../CONTRIBUTING.rst) for more details.`
	`8`	`+See [CONTRIBUTING.md](../CONTRIBUTING.md) for more details.`