docs: configure mkdocstring and add documentation

mkdocs: configure mkdocstrings add app.md with sections to add documentation to Issue #39
iacopy · Nov 3, 2023 · 278cda0 · 278cda0
1 parent 8d48015
commit 278cda0
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 0 deletions.
diff --git a/docs/app.md b/docs/app.md
@@ -0,0 +1,11 @@
+# App Documentation
+
+## Flask app
+
+::: src.flask_app.hello_world
+
+::: src.flask_app.index
+
+## Foobar
+
+::: src.foobar.sum_two_numbers
diff --git a/docs/index.md b/docs/index.md
@@ -1 +1,3 @@
 # Welcome to My Project
+
+This is my wonderful project.
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1,3 +1,8 @@
 site_name: My Docs
 nav:
   - Home: index.md
+  - App: app.md
+
+plugins:
+  - mkdocstrings:
+      default_handler: python
Original file line number	Diff line number	Diff line change
		@@ -1 +1,3 @@
		# Welcome to My Project

		This is my wonderful project.