Checking out griffe/tui/mkdocstrings

Author: georgeyk

griffe-and-docs/README.md

@@ -0,0 +1,13 @@
+# griffe and docs
+
+```shell
+# start mkdocs
+$ mkdocs serve
+
+# tui doc browser
+$ griffe-tui
+
+# json dump
+$ griffe dump src
+
+```

griffe-and-docs/docs/index.md

@@ -0,0 +1,17 @@
+# Test
+
+Some test here.
+
+---
+
+A function hello.
+
+::: griffe_and_docs.hello
+
+A module other.
+
+::: griffe_and_docs.other
+
+A class Foo.
+
+::: griffe_and_docs.other.Foo

griffe-and-docs/mkdocs.yml

@@ -0,0 +1,6 @@
+site_name: Test
+plugins:
+  - mkdocstrings:
+      handlers:
+        python:
+          paths: [src]

griffe-and-docs/pyproject.toml

@@ -0,0 +1,16 @@
+[project]
+name = "griffe-and-docs"
+version = "0.1.0"
+description = "Add your description here"
+readme = "README.md"
+requires-python = ">=3.12"
+dependencies = [
+    "griffe>=1.5.1",
+    "griffe-tui>=1.0.0",
+    "mkdocstrings-python>=1.12.2",
+    "mkdocs>=1.6.1",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"

griffe-and-docs/src/griffe_and_docs/__init__.py

@@ -0,0 +1,2 @@
+def hello() -> str:
+    return "Hello from griffe-and-docs!"

griffe-and-docs/src/griffe_and_docs/other.py

@@ -0,0 +1,6 @@
+class Foo:
+    """A Foo class for bar"""
+
+    def bar(self):
+        """A bar for foo"""
+        pass