add api and nb support to docs

Author: antheas

docs/source/.gitignore

@@ -0,0 +1 @@
+packages

docs/source/conf.py

@@ -49,6 +49,7 @@
 # ones.
 extensions = [
     "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
     "sphinx.ext.napoleon",
     "sphinx_autodoc_typehints",
     "sphinx.ext.doctest",
@@ -67,6 +68,8 @@
 # enable autosummary plugin (table of contents for modules/classes/class
 # methods)
 autosummary_generate = True
+autosummary_generate_overwrite = False
+napoleon_include_init_with_doc = True
 
 # Add any paths that contain templates here, relative to this directory.
 templates_path = ["_templates"]

docs/source/index.rst

@@ -2,13 +2,30 @@
    You can adapt this file completely to your liking, but it should at least
    contain the root `toctree` directive.
 
-Welcome to Pasteur's API docs!
+Welcome to Pasteur's documentation!
 =============================================
 
 .. toctree::
-   :maxdepth: 4
+   :maxdepth: 2
+   :caption: Introduction
 
+   intro/preliminaries
 
+.. toctree::
+   :maxdepth: 2
+   :caption: Modules
+
+
+API documentation
+=================
+
+.. autosummary::
+   :toctree: packages
+   :caption: API documentation
+   :template: autosummary/module.rst
+   :recursive:
+
+   pasteur
 
 Indices and tables
 ==================

docs/source/intro/preliminaries.ipynb

@@ -0,0 +1,24 @@
+{
+ "cells": [
+  {
+   "attachments": {},
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Preliminaries "
+   ]
+  },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": []
+  }
+ ],
+ "metadata": {
+  "language_info": {
+   "name": "python"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

src/pasteur/cli.py

@@ -1,17 +1,17 @@
 from .kedro.utils import get_pasteur_modules
 
-if get_pasteur_modules():
-    from .kedro.cli import cli
-else:
-    cli = None
+# if get_pasteur_modules():
+from .kedro.cli import cli
+# else:
+#     cli = None
 
-    import logging
+#     import logging
 
-    logger = logging.getLogger(__name__)
-    logger.warning(
-        "Pasteur project not found in the current directory "
-        + "(settings.py file doesn't contain `PASTEUR_MODULES = ...`). "
-        + "Disabling Pasteur commands."
-    )
+#     logger = logging.getLogger(__name__)
+#     logger.warning(
+#         "Pasteur project not found in the current directory "
+#         + "(settings.py file doesn't contain `PASTEUR_MODULES = ...`). "
+#         + "Disabling Pasteur commands."
+#     )
 
 __all__ = ["cli"]