small fixes

Author: nullhack

{{cookiecutter.project_slug}}/.pre-commit-config.yaml

@@ -8,7 +8,6 @@ repos:
     -   id: check-added-large-files
     -   id: check-ast
     -   id: check-case-conflict
-    -   id: fix-encoding-pragma
     -   id: check-docstring-first
     -   id: check-merge-conflict
     -   id: detect-private-key
@@ -20,22 +19,13 @@ repos:
     rev: 5.10.1
     hooks:
     -   id: isort
--   repo: local
-    hooks:
-    -   id: black-formatter
-        name: black-formatter
-        stages: [commit, push]
-        language: system
-        entry: nox -s black
-        types: [python]
-        pass_filenames: false
 -   repo: local
     hooks:
     -   id: flake8-lint
         name: flake8-lint
         stages: [commit, push]
         language: system
-        entry: nox -s lint
+        entry: poe lint
         types: [python]
         pass_filenames: false
 -   repo: local
@@ -44,16 +34,7 @@ repos:
         name: pytest
         stages: [commit]
         language: system
-        entry: nox -s tests
-        types: [python]
-        pass_filenames: false
--   repo: local
-    hooks:
-    -   id: pytest-docs
-        name: pytest-docs
-        stages: [push]
-        language: system
-        entry: nox -s test-docs
+        entry: poe test
         types: [python]
         pass_filenames: false
 -   repo: local
@@ -62,15 +43,6 @@ repos:
         name: api-documentation
         stages: [push]
         language: system
-        entry: nox -s api-docs
-        types: [python]
-        pass_filenames: false
--   repo: local
-    hooks:
-    -   id: uml-diagram
-        name: uml-diagram
-        stages: [push]
-        language: system
-        entry: nox -s uml
+        entry: poe doc
         types: [python]
         pass_filenames: false

{{cookiecutter.project_slug}}/README.md

@@ -25,7 +25,7 @@
   <p align="center">
     {{cookiecutter.project_short_description}}
     <br />
-    <a href="https://htmlpreview.github.io/?https://raw.githubusercontent.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/main/docs/api/{{cookiecutter.project_slug}}/index.html"><strong>Explore the docs »</strong></a>
+    <a href="https://{{cookiecutter.github_username}}.github.io/{{cookiecutter.project_slug}}/readme.html"><strong>Explore the docs »</strong></a>
     <br />
     <br />
     <a href="https://github.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/issues">Report Bug</a>
@@ -42,9 +42,6 @@
   <ol>
     <li>
       <a href="#about-the-project">About The Project</a>
-      <ul>
-        <li><a href="#uml-diagrams">UML Diagrams</a></li>
-      </ul>
     </li>
     <li>
       <a href="#getting-started">Getting Started</a>
@@ -74,7 +71,7 @@
 <!-- GETTING STARTED -->
 ## Getting Started
 
-To run this project locally, you will need to install the prerequisites and follow the installation section
+To run this project locally, you will need to install the prerequisites and follow the installation section.
 
 ### Prerequisites
 
@@ -146,7 +143,7 @@ Some useful examples of how this project can be used:
    ```
 
 
-_For more examples, please refer to the [Documentation](https://htmlpreview.github.io/?https://raw.githubusercontent.com/{{cookiecutter.github_username}}/{{cookiecutter.project_slug}}/main/docs/api/{{cookiecutter.project_slug}}/index.html)_
+_For more examples, please refer to the [Documentation](https://{{cookiecutter.github_username}}.github.io/{{cookiecutter.project_slug}}/readme.html)_
 
 <p align="right">(<a href="#top">back to top</a>)</p>
 

{{cookiecutter.project_slug}}/docs/gen_pages.py

@@ -1,16 +1,18 @@
-import mkdocs_gen_files
 from pathlib import Path
 
-docs_parent_dir = Path(__file__).parent.parent
+import mkdocs_gen_files
 
+docs_parent_dir = Path(__file__).parent.parent
 
+# Automagically injects README file into the documentation
 readme_path = docs_parent_dir / "README.md"
 if readme_path.exists():
     with open(readme_path, "r") as r:
         with mkdocs_gen_files.open("readme.md", "w") as f:
             f.write(r.read())
 
 
+# Injects feature files into the documentation
 head_lines = (
     "Feature:",
     "Scenario:",
@@ -37,4 +39,3 @@
                     write_line = f">    {line}"
 
                 gf.write(write_line)
-

{{cookiecutter.project_slug}}/pyproject.toml

@@ -151,6 +151,10 @@ pre-commit = "pre-commit run --all-files"
 lint = "flake8"
 doc = "mkdocs serve --use-directory-urls -f docs/mkdocs.yaml"
 doc-html = "mkdocs build --no-directory-urls -f docs/mkdocs.yaml"
+doc-publish = """mkdocs gh-deploy \
+--config-file docs/mkdocs.yaml \
+--no-directory-urls \
+--remote-branch docs"""
 
 [tool.poe.tasks.docker-build]
 cmd = """

{{cookiecutter.project_slug}}/tests/scenarios/conftest.py

@@ -11,7 +11,10 @@
 
 
 def pytest_configure(config: pytest.Config) -> None:
-    """Configure tests tp include new features.
+    """Configure tests to include new features.
+
+    This function adds new features automatically as test files.
+    Adding new features will trigger errors because steps are not implemented.
 
     Args:
         config (Config): Configuration provided by pytest.