Merge pull request #75 from wiremock/mkdocs

Move documentation to MkDocs

Author: oleg-nenashev

.github/workflows/lint-docs.yml

@@ -1,14 +1,29 @@
 name: Verify documentation
 on:
   push:
-    branches: [ "main", "master" ]
+    branches: ["main", "master"]
   pull_request:
-    branches: [ "main", "master" ]
+    branches: ["main", "master"]
 
 jobs:
-  markdown-link-check:
-    name: Check Markdown links
+  verify-docs:
+    name: Check Documentation
     runs-on: ubuntu-latest
     steps:
-    - uses: actions/checkout@master
-    - uses: gaurav-nelson/github-action-markdown-link-check@v1
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.10"
+      - name: Install Poetry
+        run: curl -sSL https://install.python-poetry.org | python
+      - name: Install dependencies
+        run: |
+          poetry env use '3.10'
+          poetry install --extras=testing
+      - name: Build docs with MkDocs
+        run: |
+          make docs
+      - name: Check Markdown links
+        uses: gaurav-nelson/github-action-markdown-link-check@v1

.gitignore

@@ -165,5 +165,6 @@ Network Trash Folder
 Temporary Items
 .apdisk
 
-# Sphinx
-html/
+# Static docs
+html/
+site/

Makefile

@@ -44,4 +44,4 @@ clean:
 	find . -name '.bak' -exec rm -f {} +
 
 docs:
-	sphinx-build docs html
+	poetry run mkdocs build --site-dir=html

docs/Makefile

@@ -0,0 +1,127 @@
+ChangeLog
+=========
+
+Changes to the library are recorded here.
+
+v2.4.0
+------
+
+Enhancements:
+
+-   Adds --root\_dir option (\#40) @dtwwolinski
+
+Maintenance:
+
+-   Automates release documentation and pypi distribution (\#63)
+    @mikeywaites
+-   Removes setuptools dependency on build (\#62) @jmdacruz
+-   Uses assertEqual instead of assertEquals for Python 3.11
+    compatibility. (\#45) @tirkarthi
+-   Updates to modern Python tooling (\#57) @mikeywaites
+-   Sets up working example of python-wiremock in the repo (\#59)
+    @mikeywaites
+-   Removes travis config file (\#61) @mikeywaites
+-   Adds imports to quickstart example (\#42) @jmendesky
+
+v2.3.1
+------
+
+> -   Adds support for --root\_dir option on startup thanks to
+>     @dtwwolinski
+
+v2.3.0
+------
+
+> -   Adds missing Metadata delete calls thanks to @andreroggeri
+
+v2.2.0
+------
+
+> -   Adds missing Metadata serde options thanks to @andreroggeri
+
+v2.1.3
+------
+
+> -   Fix on startup thanks to @Enforcer
+
+v2.1.2
+------
+
+> -   Python3.8 lint fixes thanks to @tirkarthi
+
+v2.1.1
+------
+
+> -   Fixes startup error on connection error thanks to @vasuarez
+
+v2.1.0
+------
+
+> -   Enables Templating thanks to @mauricioalarcon
+
+v2.0.0
+------
+
+> -   Fixes issue \#14
+> -   Drops support for Python 2.x as this is EOL.
+
+v1.2.0
+------
+
+> -   Add custom cert/verification options to be passed normally through
+>     the singleton config
+> -   Upgrades minimum requests version to 2.20.0 for known
+>     CVE-2018-18074
+
+v1.1.5
+------
+
+> -   Looser requirements everywhere, run free!
+
+v1.1.4
+------
+
+> -   Update links in setup.py and docs
+
+v1.1.3
+------
+
+> -   Looser dependency constraint in setup.py
+
+v1.1.2
+------
+
+> -   Allow looser dependency constraint for requests
+
+v1.1.1
+------
+
+> -   Fixed bug when wiremock jar not found.
+
+v1.1.0
+------
+
+> -   Added Ability to stand up wiremock server (requires standalone jar
+>     being available).
+
+v1.0.3
+------
+
+> -   Fix support for Python 3.4.
+
+v1.0.2
+------
+
+> -   Wiremock 2.6.x uses 201 response code instead.
+
+v1.0.1
+------
+
+> -   Bug Fix on dictionary klass deserialization fix.
+
+v1.0.0
+------
+
+> -   First Release - included admin feature set for wiremock 2.5.1
+>     standalone
+