DRIVERS-2805 Use mkdocs and publish to readthedocs

.readthedocs.yaml

@@ -0,0 +1,19 @@
+# Read the Docs configuration file for MkDocs projects
+# 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.12"
+
+mkdocs:
+  configuration: mkdocs.yml
+
+# Optionally declare the Python requirements required to build your docs
+python:
+  install:
+  - requirements: docs/requirements.txt

README.md

@@ -45,19 +45,12 @@ Astrolabe requires [Click](https://pypi.org/project/click/),
 
 ## Documentation
 
-Documentation is available at
-[github.io](https://mongodb-labs.github.io/drivers-atlas-testing/).
+Documentation is available on [ReadtheDocs](drivers-atlas-testing.readthedocs.io).
 
 To build the documentation, you will need to install
-[sphinx](https://www.sphinx-doc.org/). Documentation can be generated by
-running:
+[mkdocs](https://www.mkdocs.org/getting-started/). 
 
-```bash
-make html
-```
-
-in the `docs/` directory. Generated documentation can be found in the
-*docs/build/html/* directory.
+Run `mkdocs serve` to see a live view of the docs.
 
 ## Linting and Formatting
 

docs/index.md

@@ -1,4 +1,4 @@
-# Welcome to astrolabe's documentation!
+# Astrolabe
 
 **astrolabe** is a toolkit for testing MongoDB driver behavior during
 common MongoDB cluster reconfiguration operations. It currently supports

docs/requirements.txt

@@ -0,0 +1 @@
+mkdocs

docs/technical-design.md

@@ -1,4 +1,6 @@
-# Technical Design: Testing Drivers Against Atlas Planned Maintenance
+# Technical Design
+
+Testing Drivers Against Atlas Planned Maintenance
 
 This document is **not** updated regularly. It's only purpose is to
 provide the reader with information about design choices and decisions

mkdocs.yml

@@ -0,0 +1 @@
+site_name: My Docs

pyproject.toml

@@ -40,9 +40,6 @@ dependencies = [
     "tabulate>=0.8,<0.9",
 ]
 
-[project.optional-dependencies]
-docs = ["sphinx"]
-
 [project.scripts]
 astrolabe = "astrolabe.cli:cli"