Skip to content

Commit e809542

Browse files
leotrsleotrs
authored
Merge pull request #537 from behackl/doc-inheritance
Show inheritance in Documentation
2 parents a32302e + 9733d6a commit e809542

File tree

2 files changed

+71
-65
lines changed

2 files changed

+71
-65
lines changed

‎docs/source/_templates/autosummary/class.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
.. currentmodule:: {{ module }}
44

55
.. autoclass:: {{ objname }}
6+
:show-inheritance:
67
:members:
78

89
{% block methods %}

‎docs/source/tutorials/configuration.rst

Lines changed: 70 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -47,71 +47,76 @@ The output looks as follows.
4747
:options: -ELLIPSIS, +NORMALIZE_WHITESPACE
4848

4949
usage: manim [-h] [-o OUTPUT_FILE] [-p] [-f] [--leave_progress_bars] [-a] [-w] [-s] [-g] [-i] [--disable_caching] [--flush_cache] [--log_to_file] [-c BACKGROUND_COLOR]
50-
[--background_opacity BACKGROUND_OPACITY] [--media_dir MEDIA_DIR] [--log_dir LOG_DIR] [--tex_template TEX_TEMPLATE] [--dry_run] [-t] [-q {k,p,h,m,l}] [--low_quality] [--medium_quality]
51-
[--high_quality] [--production_quality] [--fourk_quality] [-r RESOLUTION] [-n FROM_ANIMATION_NUMBER] [--use_js_renderer] [--js_renderer_path JS_RENDERER_PATH] [--config_file CONFIG_FILE] [--custom_folders]
52-
[-v {DEBUG,INFO,WARNING,ERROR,CRITICAL}] [--progress_bar True/False]
53-
{cfg} ... file [scene_names [scene_names ...]]
54-
55-
Animation engine for explanatory math videos
56-
57-
positional arguments:
58-
{cfg}
59-
file path to file holding the python code for the scene
60-
scene_names Name of the Scene class you want to see
61-
62-
optional arguments:
63-
-h, --help show this help message and exit
64-
-o OUTPUT_FILE, --output_file OUTPUT_FILE
65-
Specify the name of the output file, if it should be different from the scene class name
66-
-p, --preview Automatically open the saved file once its done
67-
-f, --show_in_file_browser
68-
Show the output file in the File Browser
69-
--leave_progress_bars
70-
Leave progress bars displayed in terminal
71-
-a, --write_all Write all the scenes from a file
72-
-w, --write_to_movie Render the scene as a movie file (this is on by default)
73-
-s, --save_last_frame
74-
Save the last frame only (no movie file is generated)
75-
-g, --save_pngs Save each frame as a png
76-
-i, --save_as_gif Save the video as gif
77-
--disable_caching Disable caching (will generate partial-movie-files anyway)
78-
--flush_cache Remove all cached partial-movie-files
79-
--log_to_file Log terminal output to file
80-
-c BACKGROUND_COLOR, --background_color BACKGROUND_COLOR
81-
Specify background color
82-
--background_opacity BACKGROUND_OPACITY
83-
Specify background opacity
84-
--media_dir MEDIA_DIR
85-
Directory to store media (including video files)
86-
--log_dir LOG_DIR Directory to store log files
87-
--tex_template TEX_TEMPLATE
88-
Specify a custom TeX template file
89-
--dry_run Do a dry run (render scenes but generate no output files)
90-
-t, --transparent Render a scene with an alpha channel
91-
-q {k,p,h,m,l}, --quality {k,p,h,m,l}
92-
Render at specific quality, short form of the --*_quality flags
93-
--low_quality Render at low quality
94-
--medium_quality Render at medium quality
95-
--high_quality Render at high quality
96-
--production_quality Render at default production quality
97-
--fourk_quality Render at 4K quality
98-
-r RESOLUTION, --resolution RESOLUTION
99-
Resolution, passed as "height,width". Overrides any quality flags, if present
100-
-n FROM_ANIMATION_NUMBER, --from_animation_number FROM_ANIMATION_NUMBER
101-
Start rendering at the specified animation index, instead of the first animation. If you pass in two comma separated values, e.g. '3,6', it will end the rendering at the second
102-
value
103-
--use_js_renderer Render animations using the javascript frontend
104-
--js_renderer_path JS_RENDERER_PATH
105-
Path to the javascript frontend
106-
--config_file CONFIG_FILE
107-
Specify the configuration file
108-
--custom_folders Use the folders defined in the [custom_folders] section of the config file to define the output folder structure
109-
-v {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --verbosity {DEBUG,INFO,WARNING,ERROR,CRITICAL}
110-
Verbosity level. Also changes the ffmpeg log level unless the latter is specified in the config
111-
--progress_bar True/False
112-
Display the progress bar
113-
114-
Made with <3 by the manim community devs
50+
[--background_opacity BACKGROUND_OPACITY] [--media_dir MEDIA_DIR] [--log_dir LOG_DIR] [--tex_template TEX_TEMPLATE] [--dry_run] [-t] [-q {k,p,h,m,l}]
51+
[--low_quality] [--medium_quality] [--high_quality] [--production_quality] [--fourk_quality] [-l] [-m] [-e] [-k] [-r RESOLUTION] [-n FROM_ANIMATION_NUMBER]
52+
[--use_js_renderer] [--js_renderer_path JS_RENDERER_PATH] [--config_file CONFIG_FILE] [--custom_folders] [-v {DEBUG,INFO,WARNING,ERROR,CRITICAL}]
53+
[--progress_bar True/False]
54+
{cfg} ... file [scene_names [scene_names ...]]
55+
56+
Animation engine for explanatory math videos
57+
58+
positional arguments:
59+
{cfg}
60+
file path to file holding the python code for the scene
61+
scene_names Name of the Scene class you want to see
62+
63+
optional arguments:
64+
-h, --help show this help message and exit
65+
-o OUTPUT_FILE, --output_file OUTPUT_FILE
66+
Specify the name of the output file, if it should be different from the scene class name
67+
-p, --preview Automatically open the saved file once its done
68+
-f, --show_in_file_browser
69+
Show the output file in the File Browser
70+
--leave_progress_bars
71+
Leave progress bars displayed in terminal
72+
-a, --write_all Write all the scenes from a file
73+
-w, --write_to_movie Render the scene as a movie file (this is on by default)
74+
-s, --save_last_frame
75+
Save the last frame only (no movie file is generated)
76+
-g, --save_pngs Save each frame as a png
77+
-i, --save_as_gif Save the video as gif
78+
--disable_caching Disable caching (will generate partial-movie-files anyway)
79+
--flush_cache Remove all cached partial-movie-files
80+
--log_to_file Log terminal output to file
81+
-c BACKGROUND_COLOR, --background_color BACKGROUND_COLOR
82+
Specify background color
83+
--background_opacity BACKGROUND_OPACITY
84+
Specify background opacity
85+
--media_dir MEDIA_DIR
86+
Directory to store media (including video files)
87+
--log_dir LOG_DIR Directory to store log files
88+
--tex_template TEX_TEMPLATE
89+
Specify a custom TeX template file
90+
--dry_run Do a dry run (render scenes but generate no output files)
91+
-t, --transparent Render a scene with an alpha channel
92+
-q {k,p,h,m,l}, --quality {k,p,h,m,l}
93+
Render at specific quality, short form of the --*_quality flags
94+
--low_quality Render at low quality
95+
--medium_quality Render at medium quality
96+
--high_quality Render at high quality
97+
--production_quality Render at default production quality
98+
--fourk_quality Render at 4K quality
99+
-l DEPRECATED: USE -ql or --quality l
100+
-m DEPRECATED: USE -qm or --quality m
101+
-e DEPRECATED: USE -qh or --quality h
102+
-k DEPRECATED: USE -qk or --quality k
103+
-r RESOLUTION, --resolution RESOLUTION
104+
Resolution, passed as "height,width". Overrides any quality flags, if present
105+
-n FROM_ANIMATION_NUMBER, --from_animation_number FROM_ANIMATION_NUMBER
106+
Start rendering at the specified animation index, instead of the first animation. If you pass in two comma separated values, e.g. '3,6', it will end
107+
the rendering at the second value
108+
--use_js_renderer Render animations using the javascript frontend
109+
--js_renderer_path JS_RENDERER_PATH
110+
Path to the javascript frontend
111+
--config_file CONFIG_FILE
112+
Specify the configuration file
113+
--custom_folders Use the folders defined in the [custom_folders] section of the config file to define the output folder structure
114+
-v {DEBUG,INFO,WARNING,ERROR,CRITICAL}, --verbosity {DEBUG,INFO,WARNING,ERROR,CRITICAL}
115+
Verbosity level. Also changes the ffmpeg log level unless the latter is specified in the config
116+
--progress_bar True/False
117+
Display the progress bar
118+
119+
Made with <3 by the manim community devs
115120

116121
For example, to render a scene in high quality, but only output the last frame
117122
of the scene instead of the whole video, you can execute

0 commit comments

Comments
 (0)