docs: Use markdown for all documentation. (#134)

serious-scaffold · Sep 11, 2023 · 161a7b4 · 161a7b4
1 parent d560fa9
commit 161a7b4
Show file tree

Hide file tree

Showing 28 changed files with 64 additions and 68 deletions.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -27,6 +27,7 @@
     "interruptible",
     "isort",
     "JPKXI",
+    "maxdepth",
     "modindex",
     "mypy",
     "pathjoin",

diff --git a/docs/api/index.md b/docs/api/index.md
@@ -0,0 +1,6 @@
+# API Reference
+
+```{toctree}
+:maxdepth: 1
+settings
+```
diff --git a/docs/api/index.rst b/docs/api/index.rst
diff --git a/docs/api/settings.md b/docs/api/settings.md
@@ -0,0 +1,5 @@
+# serious_scaffold.settings
+
+```{eval-rst}
+.. automodule:: serious_scaffold.settings
+```
diff --git a/docs/api/settings.rst b/docs/api/settings.rst
diff --git a/docs/cli/index.md b/docs/cli/index.md
@@ -0,0 +1,6 @@
+# CLI Reference
+
+```{click} serious_scaffold.cli:typer_click_object
+:prog: serious-scaffold-cli
+:nested: full
+```
diff --git a/docs/cli/index.rst b/docs/cli/index.rst
diff --git a/docs/index.md b/docs/index.md
@@ -1,4 +1,4 @@
-# Welcome to Serious Scaffold Python's documentation!
+# Welcome to Serious Scaffold Python's documentation
 
 ```{toctree}
 :hidden:

diff --git a/docs/reports/coverage/index.md b/docs/reports/coverage/index.md
@@ -0,0 +1,3 @@
+# Coverage Reports
+
+<!-- placeholder for generated coverage reports -->
diff --git a/docs/reports/coverage/index.rst b/docs/reports/coverage/index.rst
diff --git a/docs/reports/index.md b/docs/reports/index.md
@@ -0,0 +1,7 @@
+# Code Quality Reports
+
+```{toctree}
+:maxdepth: 2
+mypy/index
+coverage/index
+```
diff --git a/docs/reports/index.rst b/docs/reports/index.rst
diff --git a/docs/reports/mypy/index.md b/docs/reports/mypy/index.md
@@ -0,0 +1,3 @@
+# MyPy Reports
+
+<!-- placeholder for generated mypy reports -->
diff --git a/docs/reports/mypy/index.rst b/docs/reports/mypy/index.rst
diff --git a/template/.vscode/settings.json b/template/.vscode/settings.json
@@ -27,6 +27,7 @@
     "interruptible",
     "isort",
     "JPKXI",
+    "maxdepth",
     "modindex",
     "mypy",
     "pathjoin",

diff --git a/template/docs/api/index.md.jinja b/template/docs/api/index.md.jinja
@@ -0,0 +1,6 @@
+# API Reference
+
+```{toctree}
+:maxdepth: 1
+settings
+```
diff --git a/template/docs/api/index.rst.jinja b/template/docs/api/index.rst.jinja
diff --git a/template/docs/api/settings.md.jinja b/template/docs/api/settings.md.jinja
@@ -0,0 +1,5 @@
+# {{ module_name }}.settings
+
+```{eval-rst}
+.. automodule:: {{ module_name }}.settings
+```
diff --git a/template/docs/api/settings.rst.jinja b/template/docs/api/settings.rst.jinja
diff --git a/template/docs/cli/index.md.jinja b/template/docs/cli/index.md.jinja
@@ -0,0 +1,6 @@
+# CLI Reference
+
+```{click} {{ module_name }}.cli:typer_click_object
+:prog: {{ package_name }}-cli
+:nested: full
+```
diff --git a/template/docs/cli/index.rst.jinja b/template/docs/cli/index.rst.jinja
diff --git a/template/docs/index.md.jinja b/template/docs/index.md.jinja
@@ -1,4 +1,4 @@
-# Welcome to {{ project_name }}'s documentation!
+# Welcome to {{ project_name }}'s documentation
 
 ```{toctree}
 :hidden:

diff --git a/template/docs/reports/coverage/index.md b/template/docs/reports/coverage/index.md
@@ -0,0 +1,3 @@
+# Coverage Reports
+
+<!-- placeholder for generated coverage reports -->
diff --git a/template/docs/reports/coverage/index.rst b/template/docs/reports/coverage/index.rst
diff --git a/template/docs/reports/index.md b/template/docs/reports/index.md
@@ -0,0 +1,7 @@
+# Code Quality Reports
+
+```{toctree}
+:maxdepth: 2
+mypy/index
+coverage/index
+```
diff --git a/template/docs/reports/index.rst b/template/docs/reports/index.rst
diff --git a/template/docs/reports/mypy/index.md b/template/docs/reports/mypy/index.md
@@ -0,0 +1,3 @@
+# MyPy Reports
+
+<!-- placeholder for generated mypy reports -->
diff --git a/template/docs/reports/mypy/index.rst b/template/docs/reports/mypy/index.rst