Skip to content

Commit 91eada2

Browse files
committed
Add flag to cli to write markdown
1 parent 1f55a88 commit 91eada2

File tree

1 file changed

+11
-2
lines changed

1 file changed

+11
-2
lines changed

src/autodoc2/cli.py

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
from autodoc2 import __name__ as package_name
1212
from autodoc2 import __version__
1313
from autodoc2.analysis import analyse_module
14-
from autodoc2.config import Config
14+
from autodoc2.config import Config, _load_renderer
1515
from autodoc2.db import InMemoryDb, UniqueError
1616
from autodoc2.resolve_all import AllResolver
1717
from autodoc2.utils import WarningSubtypes, yield_modules
@@ -197,9 +197,18 @@ def write(
197197
),
198198
# TODO read from config file, to populate config object
199199
output: Path = typer.Option("_autodoc", help="Folder to write to"),
200+
renderer: str = typer.Option(
201+
"rst",
202+
"-r",
203+
"--renderer",
204+
help="Renderer to use, rst or md",
205+
callback=lambda x: _load_renderer("render_plugin", x),
206+
),
200207
clean: bool = typer.Option(False, "-c", "--clean", help="Remove old files"),
201208
) -> None:
202209
"""Create sphinx files for a python module or package."""
210+
from autodoc2.render.base import RendererBase
211+
203212
# gather the module
204213
modules: t.Iterable[t.Tuple[Path, str]]
205214
if path.is_dir():
@@ -254,7 +263,7 @@ def write(
254263
def _warn(msg: str, type_: WarningSubtypes) -> None:
255264
progress.console.print(f"[yellow]Warning[/yellow] {msg} [{type_.value}]")
256265

257-
config = Config()
266+
config = Config(render_plugin=t.cast(RendererBase, renderer))
258267
for mod_name in to_write:
259268
progress.update(task, advance=1, description=mod_name)
260269
content = "\n".join(

0 commit comments

Comments
 (0)