From 278cda0d92cdb6ffbd9033bc01c02d419b2f3870 Mon Sep 17 00:00:00 2001 From: iacopo Date: Fri, 3 Nov 2023 14:02:51 +0100 Subject: [PATCH] docs: configure mkdocstring and add documentation mkdocs: configure mkdocstrings add app.md with sections to add documentation to Issue #39 --- docs/app.md | 11 +++++++++++ docs/index.md | 2 ++ mkdocs.yml | 5 +++++ 3 files changed, 18 insertions(+) create mode 100644 docs/app.md diff --git a/docs/app.md b/docs/app.md new file mode 100644 index 0000000..e9ef305 --- /dev/null +++ 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 index be26409..a83e465 100644 --- 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 index 096ec21..5c0783e 100644 --- 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