Add API docs

Makefile

@@ -26,3 +26,6 @@ test:
 	coverage run -m pytest .
 	coverage report -m
 	coverage html
+
+install:
+	pip install -e '.[test,docs]'

docs/reference/index.md

@@ -0,0 +1,7 @@
+# Reference - Code API
+
+Here's the reference or code API, the classes, functions, parameters, attributes, and
+all the dj-notebook parts.
+
+If you want to **learn dj-notebook** you are much better off reading the
+[usage docs](https://dj-notebook.readthedocs.io/en/latest/usage/).

docs/reference/plus.md

@@ -0,0 +1,14 @@
+# `Plus` class
+
+Here's the reference for the `Plus`  class, with all its parameters, attributes, and methods. 
+
+::: dj_notebook.shell_plus.Plus
+    options:
+        show_source: true
+        members:
+            - diagram    
+            - mermaid                            
+            - model_graph
+            - print
+            - read_frame
+            - model_graph_schema

mkdocs.yml

@@ -18,23 +18,44 @@ markdown_extensions:
   - pymdownx.superfences
 
 plugins:
-    - mkdocs-jupyter:
-          remove_tag_config:
-              remove_input_tags:
-                  - hide_code
-    - include-markdown:
-          start: <!--start-->
-          end: <!--end-->                    
-    - search
-    - social    
+  - mkdocs-jupyter:
+      remove_tag_config:
+        remove_input_tags:
+          - hide_code
+  - include-markdown:
+      start: <!--start-->
+      end: <!--end-->
+  - search
+  - social
+  - mkdocstrings:
+      handlers:
+        python:
+          options:
+            extensions:
+              - griffe_typingdoc
+            show_root_heading: true
+            show_if_no_docstring: true
+            inherited_members: true
+            members_order: source
+            separate_signature: true
+            unwrap_annotated: true
+            merge_init_into_class: true
+            docstring_section_style: spacy
+            signature_crossrefs: true
+            show_symbol_type_heading: true
+            show_symbol_type_toc: true
+
 
 nav:
   - Introduction: index.md
   - Installation:
-    - Installation: installation.md
-    - Using with PyCharm: pycharm.md
+      - Installation: installation.md
+      - Using with PyCharm: pycharm.md
   - Activation: activation.md
   - Usage: usage.ipynb
+  - Reference (Code API): 
+      - reference/index.md
+      - reference/plus.md
   - Contributing: contributing.md
   - Releasing: releasing.md
-  - Changelog: changelog.md
+  - Changelog: changelog.md

pyproject.toml

@@ -56,7 +56,9 @@ docs = [
   "mkdocs-material",
   "mkdocs-jupyter",
   "mkdocs-material[imaging]",
-  "mkdocs-include-markdown-plugin"  
+  "mkdocs-include-markdown-plugin",
+  "mkdocstrings[python]>=0.18",
+  "griffe-typingdoc==0.2.2"
 ]
 
 [project.urls]