fix documentation

berislavlopac · Oct 5, 2022 · 54bd8cc · 54bd8cc
1 parent 5222b87
commit 54bd8cc
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 35 deletions.
diff --git a/docs/css/custom.css b/docs/css/custom.css
diff --git a/docs/index.md b/docs/index.md
@@ -1,7 +1,9 @@
-# Overview
+# Momoa
 
 `momoa` is a library for definition, validation and serialisation of models based on JSONSchema specifications.
 
+[![Documentation Status](https://readthedocs.org/projects/momoa/badge/?version=latest)](https://momoa.readthedocs.io/en/latest/?badge=latest)
+
 ## Schema Object
 
 The recommended way to instantiate a JSONSchema spec - especially if the schema contains internal `$ref` references - is directly from the URI to the specification file.
@@ -100,7 +102,7 @@ assert result == {
 }
 ```
 
-Conversely, data can be deserialised from a JSON string or Python dict into a Model instance:
+Conversely, data can be deserialised from a JSON-formatted string or a Python dict into a Model instance:
 
 ```python
 from momoa import Schema

diff --git a/docs/reference.md b/docs/reference.md
diff --git a/docs/requirements.txt b/docs/requirements.txt
@@ -1,2 +1,2 @@
-mkdocs>=1.2.3
-mkapi>=1.0.14
+mkdocs>=1.3.0
+mkdocs-material>=8.5.6
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,15 +1,18 @@
 site_name: Momoa
 repo_url: https://github.com/berislavlopac/momoa
+site_url: https://momoa.readthedocs.io
 site_description: A library for definition, validation and serialisation of models based on JSONSchema specifications.
 site_author: Berislav Lopac <berislav@lopac.net>
 use_directory_urls: false
 theme:
-  name: readthedocs
-extra_css:
-  - css/custom.css
-plugins:
-  - search
-  - mkapi
+  name: material
+  icon:
+    logo: material/code-json
+markdown_extensions:
+  - pymdownx.highlight:
+      anchor_linenums: true
+  - pymdownx.inlinehilite
+  - pymdownx.snippets
+  - pymdownx.superfences
 nav:
   - index.md
-  - reference.md
diff --git a/pyproject.toml b/pyproject.toml
@@ -24,12 +24,14 @@ pytest-spec = ">=3.2.0"
 flake8 = ">=4.0.1"
 pydocstyle = ">=6.1.1"
 toml = ">=0.10.2"
-mkdocs = ">=1.3.0"
-mkapi = ">=1.0.14"
 mutmut = ">=2.4.0"
 tox = ">=3.25.0"
 tox-poetry = ">=0.4.1"
 
+[tool.poetry.group.docs.dependencies]
+mkdocs = ">=1.3.0"
+mkdocs-material = ">=8.5.6"
+
 [tool.black]
 line-length = 100
 target-version = ['py38', 'py39']