cleaning up the repo

.semaphore/semaphore.yml

@@ -10,6 +10,8 @@ global_job_config:
       - checkout
 blocks:
   - name: Code checks
+    skip:
+      when: "tag =~ '^([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?$'"
     dependencies: []
     task:
       prologue:
@@ -21,6 +23,8 @@ blocks:
           commands:
             - python -m tox -e checks
   - name: Unit tests
+    skip:
+      when: "tag =~ '^([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?$'"
     dependencies:
       - Code checks
     task:
@@ -43,27 +47,8 @@ blocks:
         on_pass:
           commands:
             - 'test-results publish "test-reports/$PY_ENV-junit.xml"'
-  - name: Documentation
-    run:
-      when: "branch = 'main' or tag =~ '^([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?$'"
-    dependencies:
-      - Code checks
-    task:
-      prologue:
-        commands:
-          - sem-version python 3.8
-          - python -m pip install -U pip mkdocs
-      jobs:
-        - name: docs
-          commands:
-            - checkout
-            - python -m mkdocs build
-      epilogue:
-        on_pass:
-          commands:
-            - artifact push job site
   - name: Publish release
-    dependencies: ["Unit tests", "Documentation"]
+    dependencies: []
     run:
       when: "tag =~ '^([1-9][0-9]*!)?(0|[1-9][0-9]*)(\.(0|[1-9][0-9]*))*((a|b|rc)(0|[1-9][0-9]*))?$'"
     task:

docs/index.md

@@ -2,6 +2,9 @@
 
 Lightweight API framework using an OpenAPI spec for routing and validation.
 
+[![Build Status](https://b11c.semaphoreci.com/badges/pyapi-server/branches/main.svg?style=shields&key=e9eeb9d2-6487-4aba-9207-e46c84f9bc6f)](https://b11c.semaphoreci.com/projects/pyapi-server)
+[![Documentation Status](https://readthedocs.org/projects/pyapi-server/badge/?version=latest)](https://pyapi-server.readthedocs.io/en/latest/?badge=latest)
+
 **PyAPI Server** is a Python library for serving REST APIs based on
 [OpenAPI](https://swagger.io/resources/open-api/) specifications. It is based on [Starlette](https://www.starlette.io) and is functionally very similar to [connexion](https://connexion.readthedocs.io), except that it aims to be fully [ASGI](https://asgi.readthedocs.io)-compliant.
 

docs/requirements.txt

@@ -1 +1,2 @@
 mkdocs>=1.2.3
+mkdocs-material

mkdocs.yml

@@ -4,6 +4,14 @@ repo_url: https://github.com/berislavlopac/pyapi-server
 site_description: Lightweight API framework using an OpenAPI spec for routing and validation.
 site_author: Berislav Lopac <[email protected]>
 theme:
-  name: readthedocs
+  name: material
+  icon:
+    logo: material/power-socket-uk
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
 nav:
   - Introduction: 'index.md'

pyproject.toml

@@ -22,7 +22,7 @@ uvicorn = {version = "^0.18.3", optional = true}
 [tool.poetry.extras]
 uvicorn = ["uvicorn"]
 
-[tool.poetry.dev-dependencies]
+[tool.poetry.group.dev.dependencies]
 mkdocs = ">=1.2.3"
 pytest-asyncio = ">=0.18.3"
 pytest-cov = ">=3.0.0"
@@ -39,6 +39,10 @@ pytest-spec = ">=3.2.0"
 tox-poetry = ">=0.4.1"
 isort = ">=5.10.1"
 
+[tool.poetry.group.docs.dependencies]
+mkdocs = ">=1.3.0"
+mkdocs-material = "^8.5.6"
+
 [tool.pytest.ini_options]
 asyncio_mode = "auto"