From 54bd8cca38f522368a86cf4300300f2f15fc7261 Mon Sep 17 00:00:00 2001 From: Berislav Lopac Date: Wed, 5 Oct 2022 23:45:25 +0100 Subject: [PATCH] fix documentation --- docs/css/custom.css | 17 ----------------- docs/index.md | 6 ++++-- docs/reference.md | 5 ----- docs/requirements.txt | 4 ++-- mkdocs.yml | 17 ++++++++++------- pyproject.toml | 6 ++++-- 6 files changed, 20 insertions(+), 35 deletions(-) delete mode 100644 docs/css/custom.css delete mode 100644 docs/reference.md diff --git a/docs/css/custom.css b/docs/css/custom.css deleted file mode 100644 index 2433d66..0000000 --- a/docs/css/custom.css +++ /dev/null @@ -1,17 +0,0 @@ -div.autodoc-signature { - font-size: large; - margin-bottom: 5px; -} - -div.autodoc-signature code { - font-size: large; -} - -div.autodoc-docstring { - padding-left: 5px; -} - -div.autodoc-members { - padding-left: 20px; - margin-bottom: 15px; -} \ No newline at end of file diff --git a/docs/index.md b/docs/index.md index 3c4dcdc..666ca85 100755 --- 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 deleted file mode 100644 index e8426af..0000000 --- a/docs/reference.md +++ /dev/null @@ -1,5 +0,0 @@ -# API Reference - -## ![mkapi](momoa.Schema) - -## ![mkapi](momoa.model.Model) diff --git a/docs/requirements.txt b/docs/requirements.txt index 4ce33f8..01c942f 100644 --- 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 index 6522217..18700e5 100755 --- 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 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 index e8c5627..a89fe72 100644 --- 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']