Migrate documentation to markdown

docs/conf.py

@@ -30,7 +30,8 @@
 # Add any Sphinx extension module names here, as strings. They can be
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
 # ones.
-extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode", "sphinx.ext.githubpages"]
+extensions = ["sphinx.ext.autodoc", "sphinx.ext.viewcode",
+        "sphinx.ext.githubpages", "myst_parser"]
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]
@@ -39,7 +40,11 @@ templates_path = ["_templates"]
 # You can specify multiple suffix as a list of string:
 #
 # source_suffix = ['.rst', '.md']
-source_suffix = ".rst"
+source_suffix = {
+    '.rst': 'restructuredtext',
+    '.txt': 'markdown',
+    '.md': 'markdown',
+}
 
 # The master toctree document.
 master_doc = "index"

docs/index.rst → docs/index.md

-.. include:: ../README.rst
+```{include} ../README.md
+```
 
-API documentation
-=================
+# API documentation
 
+```{eval-rst}
 .. automodule:: requests_http_message_signatures
    :members:
    :special-members:
-
-.. toctree::
-   :maxdepth: 2
-   :caption: Contents:
-
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
+```

pyproject.toml

@@ -27,6 +27,7 @@ requests = "^2"
 [tool.poetry.dev-dependencies]
 Sphinx = "^4.5.0"
 coverage = "^6.3.2"
+myst-parser = "^0.17.0"
 
 [build-system]
 requires = ["poetry-core>=1.0.0"]