Merge pull request #131 from machow/feat-search-paths

feat: Builder source_dir parameter for non-package loads

Author: machow

examples/weird-install/_quarto.yml

@@ -0,0 +1,22 @@
+# quarto stuff ----------------------------------------------------------------
+project:
+  type: website
+
+website:
+  title: weird-install example
+  navbar:
+    left:
+      - file: reference/index.qmd
+        text: "Reference"
+
+
+# quartodoc -------------------------------------------------------------------
+
+quartodoc:
+  package: null
+  source_dir: ./src
+  sections:
+    - title: Some functions
+      desc: These functions inspect and parse docstrings.
+      contents:
+        - some_module.some_function

examples/weird-install/src/some_module.py

@@ -0,0 +1,2 @@
+def some_function():
+    """A function defined in a random python script"""

quartodoc/autosummary.py

@@ -336,6 +336,10 @@ class Builder:
         The output path for a sidebar yaml config (by default no config generated).
     rewrite_all_pages:
         Whether to rewrite all rendered doc pages, or only those with changes.
+    source_dir:
+        A directory where source files to be documented live. This is only necessary
+        if you are not documenting a package, but collection of scripts. Use a "."
+        to refer to the current directory.
 
     """
 
@@ -377,6 +381,7 @@ def __init__(
         out_index: str = None,
         sidebar: "str | None" = None,
         rewrite_all_pages=False,
+        source_dir: "str | None" = None,
     ):
         self.layout = self.load_layout(sections=sections, package=package)
 
@@ -392,6 +397,7 @@ def __init__(
             self.out_index = out_index
 
         self.rewrite_all_pages = rewrite_all_pages
+        self.source_dir = str(Path(source_dir).absolute()) if source_dir else None
 
     def load_layout(self, sections: dict, package: str):
         # TODO: currently returning the list of sections, to make work with
@@ -414,6 +420,11 @@ def build(self, filter: str = "*"):
 
         from quartodoc import blueprint, collect
 
+        if self.source_dir:
+            import sys
+
+            sys.path.append(self.source_dir)
+
         # shaping and collection ----
 
         _log.info("Generating blueprint.")