Skip to content

Commit

Permalink
chore(docs): document config options
Browse files Browse the repository at this point in the history
  • Loading branch information
jeertmans committed Jan 2, 2025
1 parent b9215ac commit 80a1f18
Show file tree
Hide file tree
Showing 5 changed files with 49 additions and 1 deletion.
1 change: 1 addition & 0 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@
# Additional
"nbsphinx",
"myst_parser",
"sphinxcontrib.programoutput",
"sphinxext.opengraph",
"sphinx_click",
"sphinx_copybutton",
Expand Down
31 changes: 31 additions & 0 deletions docs/source/reference/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,34 @@ This page contains an exhaustive list of all the commands available with `manim-
:prog: manim-slides
:nested: full
```

# Config Options

Each converter has its own configuration options, which are listed below.

::::{dropdown} HTML
:open:
```{program-output} manim-slides convert --to=html --show-config
```
::::

::::{dropdown} Zip
:open:
:::{note}
The Zip converter inherits from the HTML converter.
:::
```{program-output} manim-slides convert --to=zip --show-config
```
::::

::::{dropdown} PDF
:open:
```{program-output} manim-slides convert --to=pdf --show-config
```
::::

::::{dropdown} HTML
:open:
```{program-output} manim-slides convert --to=pdf --show-config
```
::::
2 changes: 1 addition & 1 deletion manim_slides/convert.py
Original file line number Diff line number Diff line change
Expand Up @@ -884,7 +884,7 @@ def callback(ctx: Context, param: Parameter, value: bool) -> None:
@click.command()
@click.argument("scenes", nargs=-1)
@folder_path_option
@click.argument("dest", type=click.Path(dir_okay=False, path_type=Path), is_eager=True)
@click.argument("dest", type=click.Path(dir_okay=False, path_type=Path))
@click.option(
"--to",
type=click.Choice(["auto", "html", "pdf", "pptx", "zip"], case_sensitive=False),
Expand Down
1 change: 1 addition & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,7 @@ docs = [
"nbsphinx>=0.9.2",
"pandoc>=2.3",
"sphinx>=7.0.1",
"sphinxcontrib-programoutput>=0.18",
"sphinx-click>=4.4.0",
"sphinx-copybutton>=0.5.1",
"sphinxext-opengraph>=0.7.5",
Expand Down
15 changes: 15 additions & 0 deletions uv.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 80a1f18

Please sign in to comment.