basic docs

Author: essicolo

docs/api.rst

@@ -0,0 +1,7 @@
+API Reference
+=============
+
+.. automodule:: pandalchemy.methods
+   :members:
+   :undoc-members:
+   :show-inheritance:

docs/conf.py

@@ -6,6 +6,10 @@
 # -- Project information -----------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
 
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+
 project = 'pandalchemy'
 copyright = '2024, Essi Parent'
 author = 'Essi Parent'
@@ -14,7 +18,10 @@
 # -- General configuration ---------------------------------------------------
 # https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
 
-extensions = []
+extensions = [
+    'sphinx.ext.autodoc',
+    'nbsphinx'
+]
 
 templates_path = ['_templates']
 exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']

docs/index.rst

@@ -15,3 +15,5 @@ documentation for details.
    :maxdepth: 2
    :caption: Contents:
 
+   api
+   examples/basic-usage