Merge pull request #44 from woltapp/update-mkdocs-related-things

Update mkdocs related things

.github/workflows/test.yml

@@ -65,3 +65,4 @@ jobs:
           cd example-project
           poetry install
           poetry run pre-commit run -a
+          poetry run mkdocs build

{{cookiecutter.project_slug}}/.github/workflows/test.yml

@@ -44,4 +44,11 @@ jobs:
       - uses: ./.github/actions/python-poetry-env
         with:
           python-version: ${{ matrix.python-version }}
-      - run: poetry run pytest{% endraw %}
+      - run: poetry run pytest
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ./.github/actions/python-poetry-env
+      - run: poetry run mkdocs build{% endraw %}

{{cookiecutter.project_slug}}/README.md

@@ -50,9 +50,8 @@ pytest
 
 ### Documentation
 
-The documentation is automatically generated from the content of the [docs directory](./docs) and from the docstrings
- of the public signatures of the source code. The documentation is updated and published as a [Github project page
- ](https://pages.github.com/) automatically as part each release.
+The documentation is automatically generated from the content of the [docs directory](https://github.com/{{ cookiecutter.github_username }}/{{ cookiecutter.project_slug }}/tree/master/docs) and from the docstrings
+ of the public signatures of the source code. The documentation is updated and published as a [Github Pages page](https://pages.github.com/) automatically as part each release.
 
 ### Releasing
 

{{cookiecutter.project_slug}}/mkdocs.yml

@@ -28,9 +28,7 @@ plugins:
       default_handler: python
       handlers:
         python:
-          rendering:
+          options:
             show_signature_annotations: true
             show_source: true
             show_submodules: true
-      watch:
-        - src/{{ cookiecutter.package_name }}

{{cookiecutter.project_slug}}/pyproject.toml

@@ -45,7 +45,7 @@ flake8-debugger = "*"
 flake8-eradicate = "*"
 flake8-logging-format = "*"
 isort = "*"
-mkdocstrings = {version = ">=0.18", extras = ["python"]}
+mkdocstrings = {version = ">=0.23", extras = ["python"]}
 mkdocs-material = "*"
 mypy = "*"
 pep8-naming = "*"