Replace sphinx with mkdocs for documentation (#99)

pycontribs · Nov 11, 2024 · 09c3777 · 09c3777
1 parent dd50665
commit 09c3777
Show file tree

Hide file tree

Showing 16 changed files with 127 additions and 639 deletions.
diff --git a/.config/requirements-docs.in b/.config/requirements-docs.in
@@ -1,3 +1 @@
-Sphinx~=5.2.1
-docutils~=0.19
-MarkupSafe~=2.1.1
+mkdocs-ansible>=24.3.1
diff --git a/.gitignore b/.gitignore
@@ -30,3 +30,4 @@ test-distribute.sh
 venv/*
 src/tendo/_version.py
 coverage.lcov
+site
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -19,6 +19,10 @@ repos:
       - id: requirements-txt-fixer
       - id: check-yaml
         files: .*\.(yaml|yml)$
+        exclude: >
+          (?x)^(
+            mkdocs.yml
+          )$
   - repo: https://github.com/psf/black
     rev: 24.10.0
     hooks:

diff --git a/.readthedocs.yml b/.readthedocs.yml
diff --git a/README.md b/README.md
@@ -4,8 +4,8 @@
 
 # tendo
 
-Tendo is a python module that adds basic functionality that is
-not provided by Python. Read the [documentation](https://tendo.readthedocs.io) for more info.
+[Tendo](https://tendo.readthedocs.io) is a python module that adds basic functionality that is
+not provided by Python.
 
 - [transparent Unicode support for text file operations (BOM detection)](https://tendo.readthedocs.io/#module-tendo.singleton)
 - [console logging coloring](https://tendo.readthedocs.io/#module-tendo.colorer)
@@ -15,7 +15,7 @@ not provided by Python. Read the [documentation](https://tendo.readthedocs.io) f
 
 ## Requirements and Compatibility
 
-- python 3.8 or newer
+- python 3.10 or newer
 - tox for running tests
 
 ## Related Projects and Packages

diff --git a/docs/Makefile b/docs/Makefile
-Original file line number
+Diff line change
@@ Expand Up / @@ -30,3 +30,4 @@ test-distribute.sh @@
     venv/*
     src/tendo/_version.py
     coverage.lcov
+    site