Skip to content

Commit d5c20d1

Browse files
committed
chore(docs): update faq page
1 parent 527ce27 commit d5c20d1

File tree

1 file changed

+81
-6
lines changed

1 file changed

+81
-6
lines changed

docs/source/faq.md

Lines changed: 81 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,19 +17,45 @@ your own issue or discussion on GitHub!
1717
Everything related to installing Manim-Slides.
1818

1919
Please do not forget the carefully read through
20-
the ... page!
21-
22-
###
20+
the [installation](/installation) page!
2321

2422
## Rendering
2523

26-
##
24+
Questions related to `manim-slides render [SCENES]...`,
25+
26+
### I cannot render with ManimGL
27+
28+
ManimGL support is only garanteed to work
29+
on a very minimal set of versions, because it differs quite a lot from ManimCE,
30+
and its development is not very active.
31+
32+
The typical issues are that (1) ManimGL needs an outdated NumPy version
33+
and (2) ManimGL **should not** be installed from the GitHub repository,
34+
at least not from the `main` branch, but from a version released to PyPI.
35+
36+
To solve the NumPy issue, you can safely downgrade NumPy to a version supported
37+
by ManimGL,
38+
while ignoring the possible *conflicting dependencies* messages from `pip` (or else).
2739

2840
### Presenting
2941

42+
Questions related to `manim-slides present [SCENES]...`,
43+
or `manim-slides [SCENES]...` for short.
44+
45+
### Can I have interactive slides
3046

47+
No. Slides are pre-rendered static videos files
48+
and cannot be modified on the fly.
3149

32-
## F.A.Q
50+
If you need new to have some kind of interactive, look
51+
at the preview feature coupled with the OpenGL renderer
52+
with ManimCE or ManimGL.
53+
54+
### Slides go black when video finishes
55+
56+
This is an issue with Qt,
57+
which cannot be solve on all platforms and Python versions,
58+
see [#293](https://github.com/jeertmans/manim-slides/issues/293).
3359

3460
### How to increase quality on Windows
3561

@@ -41,7 +67,56 @@ in [#20](https://github.com/jeertmans/manim-slides/issues/20),
4167
the problem can be addressed by changing the scaling factor to 100%:
4268

4369
<p align="center">
44-
<img alt="Windows Fix Scaling" src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/windows_quality_fix.png">
70+
<img
71+
alt="Windows Fix Scaling"
72+
src="https://raw.githubusercontent.com/jeertmans/manim-slides/main/static/windows_quality_fix.png"
73+
>
4574
</p>
4675
4776
in *Settings*->*Display*.
77+
78+
## Converting to any format
79+
80+
Questions that apply to all output formats when using
81+
`manim-slides convert [SCENES]...`.
82+
83+
### What are all possible configuration options
84+
85+
Configuration options can be specified with the syntax
86+
`-c<option_name>=<option_value>`.
87+
88+
To list all accepted options, use `manim-slides convert --to=FORMAT --show-config`,
89+
where `FORMAT` is one of the supported formats.
90+
This will also show the default value for each option.
91+
92+
### How to retrieve the current template
93+
94+
If you want to create your own template, the best is to start from the default one.
95+
96+
You can either download it from the
97+
[template folder](https://github.com/jeertmans/manim-slides/tree/main/manim_slides/templates)
98+
or use the `manim-slides convert --to=FORMAT --show-template` command,
99+
where `FORMAT` is one of the supported formats.
100+
101+
## Converting to HTML
102+
103+
Questions related to `manim-slides convert [SCENES]... output.html`.
104+
105+
### I moved my `.html` file and it stopped working
106+
107+
If you did not specify `-cdata_uri=true` when converting,
108+
then Manim Slides generated a folder containing all
109+
the video files, in the same folder as the HTML
110+
output. As the path to video files is a relative path,
111+
you need to move the HTML **and its assets** altogether.
112+
113+
## Converting to PPTX
114+
115+
Questions related to `manim-slides convert [SCENES]... output.pptx`.
116+
117+
### My media stop playing after a few slides
118+
119+
This issue is (probably) caused by PowerPoint never freeing
120+
memory, causing memory allocation errors, and can be partially
121+
solved by reducing the video quality or the number of slides,
122+
see [#392](https://github.com/jeertmans/manim-slides/issues/392).

0 commit comments

Comments
 (0)