Add a docstring to docs - just testing this bit out

MrCurtis · Jan 27, 2024 · fc04562 · fc04562
1 parent a3015db
commit fc04562
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 0 deletions.
diff --git a/docs/index.md b/docs/index.md
@@ -2,6 +2,8 @@
 
 For full documentation visit [mkdocs.org](https://www.mkdocs.org).
 
+::: fk_graph.get_graph
+
 ## Commands
 
 * `mkdocs new [dir-name]` - Create a new project.

diff --git a/docs_requirements.txt b/docs_requirements.txt
@@ -1 +1,2 @@
 mkdocs==1.5.3
+mkdocstrings[python]==0.24.0
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -1 +1,4 @@
 site_name: FK-Graph Docs
+
+plugins:
+  - mkdocstrings