Changing documentation to mkdocs and plugins to automatically document and create features

Author: nullhack

{{cookiecutter.project_slug}}/.flake8

@@ -1,12 +1,11 @@
 [flake8]
-#ignore = E203, E266, E501, W503, T499, ANN101, ANN102, ANN002, ANN003, S101, SCS108 
-ignore = E501,SCS109
+ignore = E203, E266, E501, W503, T499
 max-line-length = 79
 enable-extensions=G
-#select = B,C,E,F,W,T4,T0,N8,DC,DAR,SCS
+#select = B,C,E,F,W,T4,T0,N8,DC,DAR
 import-order-style = google
 docstring-convention = google
-per-file-ignores = tests/*:S101, SCS108
+per-file-ignores = tests/*:S101
 max-complexity = 10
 exclude =
     docs/

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

@@ -0,0 +1,40 @@
+import mkdocs_gen_files
+from pathlib import Path
+
+docs_parent_dir = Path(__file__).parent.parent
+
+
+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())
+
+
+head_lines = (
+    "Feature:",
+    "Scenario:",
+    "Scenario Outline:",
+    "Rule:",
+    "Example:",
+    "Background:",
+)
+ignore_lines = ("@", "#")
+features_dir = docs_parent_dir / "features"
+for feature_path in features_dir.glob("**/*.feature"):
+    with open(feature_path, "r") as f:
+        relative_dir = feature_path.parent.relative_to(features_dir)
+        with mkdocs_gen_files.open(
+            f"scenarios/{relative_dir}/{feature_path.stem}.md", "w"
+        ) as gf:
+            f_line_list = f.readlines()
+            for line in f_line_list:
+                if any([line.strip().startswith(l) for l in head_lines]):
+                    write_line = f"### {line}\n"
+                elif any([line.strip().startswith(l) for l in ignore_lines]):
+                    continue
+                else:
+                    write_line = f">    {line}"
+
+                gf.write(write_line)
+

{{cookiecutter.project_slug}}/docs/mkdocs.yaml

@@ -7,12 +7,18 @@ site_dir: html
 plugins:
   - search
   - mkapi
+  - awesome-pages
+  - gen-files:
+      scripts:
+        - gen_pages.py
 
 theme:
-    name: readthedocs
+    name: material
 
 nav:
   - index.md
+  - ... | readme.md
+  - ... | scenarios/**/*.md
   - API: mkapi/api/{{cookiecutter.package_name}}
   - Tests: mkapi/tests/tests