Migrating from sphinx to Material for MkDocs (#715)

.github/workflows/ci.yml

@@ -53,26 +53,6 @@ jobs:
         if: always()
         with:
           files: ./**/coverage*.xml
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout Repo
-        uses: actions/checkout@v4
-      - name: Set up Python
-        uses: actions/setup-python@v5
-        with:
-          python-version: '3.10'
-          cache: 'pip'
-      - name: Install package
-        run: |
-          pip install -e '.[docs]'
-      - name: Run tests
-        run: |
-          sphinx-build -W -b html docs/ _build/html
-      - uses: actions/upload-artifact@v4
-        with:
-          name: Documentation
-          path: _build/html
   benchmarks:
     runs-on: ubuntu-latest
     steps:

.gitignore

@@ -60,9 +60,8 @@ junit/
 # Django stuff:
 *.log
 
-# Sphinx documentation
-docs/_build/
-_build/
+# mkdocs documentation
+site/
 
 # PyBuilder
 target/

.readthedocs.yml

@@ -1,13 +1,20 @@
+# 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.10"
+    python: "3.12"
 
-sphinx:
-  configuration: docs/conf.py
+mkdocs:
+  configuration: mkdocs.yml
+  fail_on_warning: false
 
+# Optionally declare the Python requirements required to build your docs
 python:
   install:
   - method: pip

docs/conduct.rst → docs/conduct.md

@@ -1,8 +1,6 @@
-Contributor Covenant Code of Conduct
-====================================
+# Code of Conduct
 
-Our Pledge
-----------
+## Our Pledge
 
 We as members, contributors, and leaders pledge to make participation in
 our community a harassment-free experience for everyone, regardless of
@@ -14,8 +12,7 @@ race, religion, or sexual identity and orientation.
 We pledge to act and interact in ways that contribute to an open,
 welcoming, diverse, inclusive, and healthy community.
 
-Our Standards
--------------
+## Our Standards
 
 Examples of behavior that contributes to a positive environment for our
 community include:
@@ -40,8 +37,7 @@ Examples of unacceptable behavior include:
 -  Other conduct which could reasonably be considered inappropriate in a
    professional setting
 
-Enforcement Responsibilities
-----------------------------
+## Enforcement Responsibilities
 
 Community leaders are responsible for clarifying and enforcing our
 standards of acceptable behavior and will take appropriate and fair
@@ -53,35 +49,32 @@ reject comments, commits, code, wiki edits, issues, and other
 contributions that are not aligned to this Code of Conduct, and will
 communicate reasons for moderation decisions when appropriate.
 
-Scope
------
+## Scope
 
 This Code of Conduct applies within all community spaces, and also
 applies when an individual is officially representing the community in
 public spaces. Examples of representing our community include using an
 official e-mail address, posting via an official social media account,
 or acting as an appointed representative at an online or offline event.
 
-Enforcement
------------
+## Enforcement
+
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may
 be reported to the community leaders responsible for enforcement at
-`hameerabbasi@yahoo.com <mailto:hameerabbasi@yahoo.com>`_. All complaints will be reviewed and
+[hameerabbasi@yahoo.com](mailto:hameerabbasi@yahoo.com). All complaints will be reviewed and
 investigated promptly and fairly.
 
 All community leaders are obligated to respect the privacy and security
 of the reporter of any incident.
 
-Enforcement Guidelines
-----------------------
+## Enforcement Guidelines
 
 Community leaders will follow these Community Impact Guidelines in
 determining the consequences for any action they deem in violation of
 this Code of Conduct:
 
-1. Correction
-~~~~~~~~~~~~~
+### 1. Correction
 
 **Community Impact**: Use of inappropriate language or other behavior
 deemed unprofessional or unwelcome in the community.
@@ -91,8 +84,7 @@ providing clarity around the nature of the violation and an explanation
 of why the behavior was inappropriate. A public apology may be
 requested.
 
-2. Warning
-~~~~~~~~~~
+### 2. Warning
 
 **Community Impact**: A violation through a single incident or series of
 actions.
@@ -104,8 +96,7 @@ time. This includes avoiding interactions in community spaces as well as
 external channels like social media. Violating these terms may lead to a
 temporary or permanent ban.
 
-3. Temporary Ban
-~~~~~~~~~~~~~~~~
+### 3. Temporary Ban
 
 **Community Impact**: A serious violation of community standards,
 including sustained inappropriate behavior.
@@ -117,8 +108,7 @@ unsolicited interaction with those enforcing the Code of Conduct, is
 allowed during this period. Violating these terms may lead to a
 permanent ban.
 
-4. Permanent Ban
-~~~~~~~~~~~~~~~~
+### 4. Permanent Ban
 
 **Community Impact**: Demonstrating a pattern of violation of community
 standards, including sustained inappropriate behavior, harassment of an
@@ -128,17 +118,17 @@ individuals.
 **Consequence**: A permanent ban from any sort of public interaction
 within the community.
 
-Attribution
------------
+## Attribution
+
 
-This Code of Conduct is adapted from the `Contributor
-Covenant <https://www.contributor-covenant.org>`__, version 2.0,
+This Code of Conduct is adapted from the [Contributor
+Covenant](https://www.contributor-covenant.org), version 2.0,
 available at
-https://www.contributor-covenant.org/version/2/0/code\_of\_conduct.html.
+[https://www.contributor-covenant.org/version/2/0/code\_of\_conduct.html](https://www.contributor-covenant.org/version/2/0/code\_of\_conduct.html).
 
-Community Impact Guidelines were inspired by `Mozilla's code of conduct
-enforcement ladder <:ghuser:`mozilla/diversity`>`__.
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/inclusion).
 
 For answers to common questions about this code of conduct, see the FAQ
-at https://www.contributor-covenant.org/faq. Translations are available
-at https://www.contributor-covenant.org/translations.
+at [https://www.contributor-covenant.org/faq](https://www.contributor-covenant.org/faq). Translations are available
+at [https://www.contributor-covenant.org/translations](https://www.contributor-covenant.org/translations).