Skip to content

Commit e50271b

Browse files
feat(cli): document config options (#485)
* feat(cli): document config options * chpre(docs): add changelog entry * fixes * chore(deps): remove restriction * fix(deps): PySide6 issue See astral-sh/uv#10056 * chore(docs): document config options * chore(fmt): auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci * fox(docs): deps * chore(tests): remove old test * chore(fmt): auto fixes from pre-commit.com hooks for more information, see https://pre-commit.ci --------- Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
1 parent 98955be commit e50271b

File tree

8 files changed

+739
-373
lines changed

8 files changed

+739
-373
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
4545
- Added `--offline` option to `manim-slides convert` for offline
4646
HTML presentations.
4747
[#440](https://github.com/jeertmans/manim-slides/pull/440)
48+
- Added documentation to config option to `manim-slides convert`
49+
when using `--show-config`.
50+
[#485](https://github.com/jeertmans/manim-slides/pull/485)
4851

4952
(v5.1.10-changed)=
5053
### Changed

docs/source/conf.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,9 +30,11 @@
3030
# Additional
3131
"nbsphinx",
3232
"myst_parser",
33+
"sphinxcontrib.programoutput",
3334
"sphinxext.opengraph",
3435
"sphinx_click",
3536
"sphinx_copybutton",
37+
"sphinx_design",
3638
# Custom
3739
"manim_slides.docs.manim_slides_directive",
3840
]

docs/source/reference/cli.md

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,30 @@ This page contains an exhaustive list of all the commands available with `manim-
88
:prog: manim-slides
99
:nested: full
1010
```
11+
12+
## All config options
13+
14+
Each converter has its own configuration options, which are listed below.
15+
16+
::::{dropdown} HTML
17+
```{program-output} manim-slides convert --to=html --show-config
18+
```
19+
::::
20+
21+
::::{dropdown} Zip
22+
:::{note}
23+
The Zip converter inherits from the HTML converter.
24+
:::
25+
```{program-output} manim-slides convert --to=zip --show-config
26+
```
27+
::::
28+
29+
::::{dropdown} PDF
30+
```{program-output} manim-slides convert --to=pdf --show-config
31+
```
32+
::::
33+
34+
::::{dropdown} HTML
35+
```{program-output} manim-slides convert --to=pdf --show-config
36+
```
37+
::::

0 commit comments

Comments
 (0)