Merge pull request #107 from machow/feat-cli

feat: add cli entrypoint

Author: machow

Makefile

@@ -5,8 +5,8 @@ examples/%/_site: examples/%/_quarto.yml
 	cd examples/$* \
 		&& quarto add --no-prompt ../.. \
 		&& quarto add --no-prompt quarto-ext/shinylive
-	cd examples/$* && python -m quartodoc build _quarto.yml --verbose
-	cd examples/$* && python -m quartodoc interlinks
+	cd examples/$* && quartodoc build _quarto.yml --verbose
+	cd examples/$* && quartodoc interlinks
 	quarto render $(dir $<)
 
 docs/examples/%: examples/%/_site
@@ -17,8 +17,8 @@ docs-build-examples: docs/examples/single-page docs/examples/pkgdown docs/exampl
 
 docs-build: docs-build-examples
 	cd docs && quarto add --no-prompt ..
-	cd docs && python -m quartodoc build
-	cd docs && python -m quartodoc interlinks
+	cd docs && quartodoc build
+	cd docs && quartodoc interlinks
 	quarto render docs
 
 requirements-dev.txt:

quartodoc/renderers/base.py

@@ -74,10 +74,22 @@ def from_config(cls, cfg: "dict | Renderer | str"):
             raise TypeError(type(cfg))
 
         if style.endswith(".py"):
+            import os
+            import sys
             import importlib
 
-            mod = importlib.import_module(style.rsplit(".", 1)[0])
-            return mod.Renderer(**cfg)
+            # temporarily add the current directory to sys path and import
+            # this ensures that even if we're executing the quartodoc cli,
+            # we can import a custom _renderer.py file.
+            # it probably isn't ideal, but seems like a more convenient
+            # option than requiring users to register entrypoints.
+            sys.path.append(os.getcwd())
+
+            try:
+                mod = importlib.import_module(style.rsplit(".", 1)[0])
+                return mod.Renderer(**cfg)
+            finally:
+                sys.path.pop()
 
         subclass = cls._registry[style]
         return subclass(**cfg)

setup.cfg

@@ -39,6 +39,10 @@ dev =
     jupyterlab
     jupytext
 
+[options.entry_points]
+console_scripts =
+    quartodoc = quartodoc.__main__:cli
+
 
 [project.scripts]
 quartodoc = "quartodoc.cli:main"