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>
jeertmans · Jan 3, 2025 · e50271b · e50271b
1 parent 98955be
commit e50271b
Show file tree

Hide file tree

Showing 8 changed files with 739 additions and 373 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -45,6 +45,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Added `--offline` option to `manim-slides convert` for offline
   HTML presentations.
   [#440](https://github.com/jeertmans/manim-slides/pull/440)
+- Added documentation to config option to `manim-slides convert`
+  when using `--show-config`.
+  [#485](https://github.com/jeertmans/manim-slides/pull/485)
 
 (v5.1.10-changed)=
 ### Changed

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -30,9 +30,11 @@
     # Additional
     "nbsphinx",
     "myst_parser",
+    "sphinxcontrib.programoutput",
     "sphinxext.opengraph",
     "sphinx_click",
     "sphinx_copybutton",
+    "sphinx_design",
     # Custom
     "manim_slides.docs.manim_slides_directive",
 ]

diff --git a/docs/source/reference/cli.md b/docs/source/reference/cli.md
@@ -8,3 +8,30 @@ This page contains an exhaustive list of all the commands available with `manim-
     :prog: manim-slides
     :nested: full
 ```
+
+## All config options
+
+Each converter has its own configuration options, which are listed below.
+
+::::{dropdown} HTML
+```{program-output} manim-slides convert --to=html --show-config
+```
+::::
+
+::::{dropdown} Zip
+:::{note}
+The Zip converter inherits from the HTML converter.
+:::
+```{program-output} manim-slides convert --to=zip --show-config
+```
+::::
+
+::::{dropdown} PDF
+```{program-output} manim-slides convert --to=pdf --show-config
+```
+::::
+
+::::{dropdown} HTML
+```{program-output} manim-slides convert --to=pdf --show-config
+```
+::::