mkdocs-material 9.4.8

.requirements/docs.txt

@@ -1,6 +1,6 @@
 # mkdocs requirements
-mkdocs-material==9.2.3
+mkdocs-material==9.4.8
 mkdocstrings[python]==0.22.0
 mkdocs-gen-files==0.5.0
 mkdocs-literate-nav==0.6.0
-mkdocs-section-index==0.3.5
+mkdocs-section-index==0.3.8

README.md

@@ -80,6 +80,7 @@ async with SignACMEClient.from_state(state) as client:
 
 * Pure-Python implementation.
 * Asynchronous.
+* Fully typed.
 * Clean API.
 * Robust well-tested code.
 * 97%+ test coverage.

docs/index.md

@@ -77,6 +77,7 @@ async with SignACMEClient.from_state(state) as client:
 
 * Pure-Python implementation.
 * Asynchronous.
+* Fully typed.
 * Clean API.
 * Robust well-tested code.
 * 97+% test coverage.

docs/testing.md

@@ -0,0 +1,103 @@
+# Building and Testing
+
+Before starting building and testing package set up 
+[Developer's Environment](environment.md) first.
+From here and below we consider the shell's current
+directory matches the project's root directory.
+
+## Building Package
+
+To test the package build run:
+
+```
+$ python -m build --sdist --wheel
+```
+
+Compiled packages will be available in the `dist/` directory.
+
+## Running tests
+
+To run the test suit:
+
+```
+$ pytest -vv
+```
+
+## Running Lints
+
+All lints are checked as part of GitHub Actions Workflow. You may run lints
+manually before committing to the project.
+
+### Check Formatting
+
+[Python Code Formatting](codequality.md#python-code-formatting) is the mandatory
+requirement in our [Code Quality](codequality.md) standards. To check code
+formatting run:
+
+```
+$ black --check examples/ src/ tests/
+```
+
+To fix formatting errors run:
+```
+$ black examples/ src/ tests/
+```
+
+We recommend setting python code formatting on file saving
+(Done in [VS Code Dev Container](environment.md#visual-studio-code-dev-container)
+out of the box).
+
+### Python Code Lints
+
+[Python Code Linting](codequality.md#python-code-linting) is the mandatory
+requirement in our [Code Quality](codequality.md) standards. To check code
+for linting errors run:
+
+```
+$ ruff examples/ src/ tests/
+```
+
+### Python Code Static Checks
+
+[Python Code Static Checks](codequality.md#python-code-static-checks) is the mandatory
+requirement in our [Code Quality](codequality.md) standards. To check code
+for typing errors run:
+
+```
+$ mypy --strict src/
+```
+
+## Python Test Code Coverage Check
+
+To evaluate code coverage run tests:
+
+```
+$ coverage run -m pytest -vv
+```
+
+To report the coverage after the test run:
+
+```
+$ coverage report
+```
+
+To show line-by-line coverage:
+
+```
+$ coverage html
+```
+
+Then open `dist/coverage/index.html` file in your browser.
+
+## Building Documentation
+
+To rebuild and check documentation run
+
+```
+$ mkdocs serve
+```
+
+We recommend using [Grammarly][Grammarly] service to check
+documentation for common errors.
+
+[Grammarly]: https://grammarly.com/

mkdocs.yml

@@ -87,8 +87,8 @@ markdown_extensions:
   - pymdownx.tasklist:
       custom_checkbox: true
   - pymdownx.emoji:
-      emoji_index: !!python/name:materialx.emoji.twemoji
-      emoji_generator: !!python/name:materialx.emoji.to_svg
+      emoji_index: !!python/name:material.extensions.emoji.twemoji
+      emoji_generator: !!python/name:material.extensions.emoji.to_svg
 extra:
   analytics:
     provider: google