Mkdocs (#30)

* converted docs to mkdocs

Author: Florian Maas

.github/workflows/on-merge-to-main.yml

@@ -24,7 +24,7 @@ jobs:
       - name: Documentation Test
         run: |
           source .venv/bin/activate
-          make docs-test
+          make docs-verify
 
   tox:
     runs-on: ubuntu-latest

.github/workflows/on-pull-request.yml

@@ -21,7 +21,7 @@ jobs:
       - name: Documentation Test
         run: |
           source .venv/bin/activate
-          make docs-test
+          make docs-verify
 
   tox:
     runs-on: ubuntu-latest

.github/workflows/on-release-main.yml

@@ -22,7 +22,7 @@ jobs:
       - name: Documentation Test
         run: |
           source .venv/bin/activate
-          make docs-test
+          make docs-verify
 
   tox:
     runs-on: ubuntu-latest
@@ -83,10 +83,4 @@ jobs:
       - name: Generate documentation
         run: |
             source .venv/bin/activate
-            make docs-build
-
-      - name: Deploy documentation to GitHub pages
-        uses: peaceiris/actions-gh-pages@v3
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: ./docs/_build
+            mkdocs gh-deploy

Makefile

@@ -41,19 +41,11 @@ publish: ## publish a release to pypi.
 
 build-and-publish: build publish ## Build and publish.
 
-docs-test: ## Test Sphinx documentation.
-	@sphinx-build docs docs/_build -W --keep-going
+docs-verify: ## Check if MkDocs build does not return warnings or errors
+	@mkdocs build -s
 
-docs-clean: ## Clean the docs/_build folder 
-	@rm -rf docs/_build/*
-
-docs-build: ## Build the documentation
-	@sphinx-build docs docs/_build
-
-docs-open: ## Open the documentation
-	@open docs/_build/index.html
-
-docs: docs-clean docs-build docs-open ## Build and open the documentation
+docs-serve: ## Build and serve the MkDocs documentation
+	@mkdocs serve
 
 .PHONY: help
 

README.rst

@@ -36,8 +36,6 @@ Cookiecutter Poetry
 
 This is a `cookiecutter <https://github.com/cookiecutter/cookiecutter>`_ repository to generate the file structure for a Python project that uses `Poetry <https://python-poetry.org/>`_ for its dependency management.
 
-+-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
-| **Github repository**         | `https://github.com/fpgmaas/cookiecutter-poetry/ <https://github.com/fpgmaas/cookiecutter-poetry/>`_                                 |
 +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+
 | **Documentation**             | `https://fpgmaas.github.io/cookiecutter-poetry/ <https://fpgmaas.github.io/cookiecutter-poetry/>`_                                   |
 +-------------------------------+--------------------------------------------------------------------------------------------------------------------------------------+