mirror of
https://github.com/3b1b/manim.git
synced 2025-04-13 09:47:07 +00:00
268 lines
No EOL
17 KiB
HTML
268 lines
No EOL
17 KiB
HTML
<!doctype html>
|
||
<html class="no-js">
|
||
<head><meta charset="utf-8"/>
|
||
<meta name="viewport" content="width=device-width,initial-scale=1"/><meta name="viewport" content="width=device-width, initial-scale=1" />
|
||
<link rel="index" title="Index" href="genindex.html" /><link rel="search" title="Search" href="search.html" /><link rel="next" title="Installation" href="getting_started/installation.html" />
|
||
|
||
<link rel="shortcut icon" href="_static/icon.png"/><meta name="generator" content="sphinx-3.0.3, furo 2020.10.05.beta9"/>
|
||
<title>Home - manim documentation</title>
|
||
<link rel="stylesheet" href="_static/copybutton.css" />
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/manim-kindergarten/CDN@master/manimgl_assets/custom.css" />
|
||
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/manim-kindergarten/CDN@master/manimgl_assets/colors.css" />
|
||
<link rel="stylesheet" href="_static/styles/default.css?cd459417726e1efbedae77fa">
|
||
<link rel="stylesheet" href="_static/pygments.css?cd459417726e1efbedae77fa">
|
||
|
||
<style>
|
||
:root {
|
||
--color-code-background: #f8f8f8;
|
||
--color-code-foreground: #000000;
|
||
|
||
}
|
||
</style>
|
||
<script id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script><script src="_static/jquery.js"></script>
|
||
<script src="_static/underscore.js"></script>
|
||
|
||
<script src="_static/doctools.js" defer></script>
|
||
|
||
<script src="_static/language_data.js" defer></script>
|
||
|
||
<script src="_static/clipboard.min.js"></script>
|
||
<script src="_static/copybutton.js"></script><script src="_static/scripts/main.js?cd459417726e1efbedae77fa"></script></head>
|
||
<body dir="">
|
||
|
||
<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
|
||
<symbol id="svg-toc" viewBox="0 0 24 24">
|
||
<title>Contents</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||
stroke-width="1.5" stroke="#101010" stroke-linecap="round" stroke-linejoin="round">
|
||
<path stroke="none" d="M0 0h24v24H0z"/>
|
||
<line x1="4" y1="6" x2="20" y2="6" />
|
||
<line x1="10" y1="12" x2="20" y2="12" />
|
||
<line x1="6" y1="18" x2="20" y2="18" />
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-menu" viewBox="0 0 24 24">
|
||
<title>Menu</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||
class="feather feather-menu">
|
||
<line x1="3" y1="12" x2="21" y2="12"></line>
|
||
<line x1="3" y1="6" x2="21" y2="6"></line>
|
||
<line x1="3" y1="18" x2="21" y2="18"></line>
|
||
</svg>
|
||
</symbol>
|
||
<symbol id="svg-arrow-right" viewBox="0 0 24 24">
|
||
<title>Expand</title>
|
||
<svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none"
|
||
stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round"
|
||
class="feather feather-chevron-right">
|
||
<polyline points="9 18 15 12 9 6"></polyline>
|
||
</svg>
|
||
</symbol>
|
||
</svg>
|
||
|
||
<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
|
||
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
|
||
<label class="overlay sidebar-overlay" for="__navigation"></label>
|
||
<label class="overlay toc-overlay" for="__toc"></label>
|
||
|
||
|
||
<div class="page">
|
||
<header class="mobile-header">
|
||
<label class="header-left nav-overlay-icon" for="__navigation">
|
||
<i class="icon"><svg><use href="#svg-menu"></use></svg></i>
|
||
</label>
|
||
<div class="header-center"><div class="brand">manim documentation</div></div>
|
||
<div class="header-right"></div>
|
||
</header>
|
||
<aside class="sidebar-drawer">
|
||
<div class="sidebar-container">
|
||
|
||
<div class="sidebar-sticky"><a class="sidebar-brand centered" href="#">
|
||
<div class="sidebar-logo-container">
|
||
<img class="sidebar-logo" src="_static/transparent_graph.png" alt="Logo"/>
|
||
</div>
|
||
|
||
</a><form class="sidebar-search-container" method="get" action="search.html">
|
||
<input class="sidebar-search" placeholder="Search" name="q">
|
||
<input type="hidden" name="check_keywords" value="yes">
|
||
<input type="hidden" name="area" value="default">
|
||
</form><div class="sidebar-tree sidebar-scroll">
|
||
<p><span class="caption-text">Getting Started</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/installation.html">Installation</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/quickstart.html">Quick Start</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/configuration.html">CLI flags and configuration</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/example_scenes.html">Example Scenes</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/structure.html">Manim’s structure</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/whatsnew.html">What’s new</a></li>
|
||
</ul>
|
||
<p><span class="caption-text">Documentation</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="documentation/constants.html">constants</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="documentation/custom_config.html">custom_config</a></li>
|
||
</ul>
|
||
<p><span class="caption-text">Development</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="development/changelog.html">Changelog</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="development/contributing.html">Contributing</a></li>
|
||
<li class="toctree-l1"><a class="reference internal" href="development/about.html">About</a></li>
|
||
</ul>
|
||
|
||
</div>
|
||
</div>
|
||
|
||
</div>
|
||
</aside>
|
||
<main class="main">
|
||
<div class="content">
|
||
<article role="main">
|
||
<label class="toc-overlay-icon no-toc" for="__toc">
|
||
<i class="icon"><svg><use href="#svg-toc"></use></svg></i>
|
||
</label>
|
||
<section id="manim-s-documentation">
|
||
<h1>Manim’s documentation<a class="headerlink" href="#manim-s-documentation" title="Permalink to this headline">¶</a></h1>
|
||
<img alt="https://cdn.jsdelivr.net/gh/3b1b/manim@master/logo/white_with_name.png" src="https://cdn.jsdelivr.net/gh/3b1b/manim@master/logo/white_with_name.png"/>
|
||
<p>Manim is an animation engine for explanatory math videos. It’s used to create precise animations programmatically, as seen in the videos
|
||
at <a class="reference external" href="https://www.3blue1brown.com/">3Blue1Brown</a>.</p>
|
||
<p>And here is a Chinese version of this documentation: <a class="reference external" href="https://docs.manim.org.cn/">https://docs.manim.org.cn/</a></p>
|
||
<div class="toctree-wrapper compound">
|
||
<p><span class="caption-text">Getting Started</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/installation.html">Installation</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#install-ffmpeg">Install FFmpeg</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#install-ffmpeg-windows">Install FFmpeg Windows</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#install-ffmepeg-linux"># Install FFmepeg Linux</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#install-ffmpeg-macos"># Install FFmpeg MacOS</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#directly">Directly</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#directly-windows">Directly (Windows)</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/installation.html#for-anaconda">For Anaconda</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/quickstart.html">Quick Start</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/quickstart.html#make-an-image">Make an image</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/quickstart.html#add-animations">Add animations</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/quickstart.html#enable-interaction">Enable interaction</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/quickstart.html#you-succeeded">You succeeded!</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/configuration.html">CLI flags and configuration</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/configuration.html#command-line-interface">Command Line Interface</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/configuration.html#custom-config">custom_config</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/example_scenes.html">Example Scenes</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/example_scenes.html#interactivedevlopment">InteractiveDevlopment</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/example_scenes.html#animatingmethods">AnimatingMethods</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/example_scenes.html#textexample">TextExample</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/example_scenes.html#textransformexample">TexTransformExample</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/example_scenes.html#updatersexample">UpdatersExample</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/example_scenes.html#coordinatesystemexample">CoordinateSystemExample</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/example_scenes.html#graphexample">GraphExample</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/example_scenes.html#surfaceexample">SurfaceExample</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/example_scenes.html#openingmanimexample">OpeningManimExample</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/structure.html">Manim’s structure</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/structure.html#manim-s-directory-structure">Manim’s directory structure</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/structure.html#inheritance-structure-of-manim-s-classes">Inheritance structure of manim’s classes</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/structure.html#manim-execution-process">Manim execution process</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="getting_started/whatsnew.html">What’s new</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="getting_started/whatsnew.html#usage-changes-of-new-version-manim">Usage changes of new version manim</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="toctree-wrapper compound">
|
||
<p><span class="caption-text">Documentation</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="documentation/constants.html">constants</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/constants.html#frame-and-pixel-shape">Frame and pixel shape</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/constants.html#buffs">Buffs</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/constants.html#run-times">Run times</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/constants.html#coordinates">Coordinates</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/constants.html#mathematical-constant">Mathematical constant</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/constants.html#text">Text</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/constants.html#stroke-width">Stroke width</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/constants.html#colours">Colours</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="documentation/custom_config.html">custom_config</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#directories"><code class="docutils literal notranslate"><span class="pre">directories</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#tex"><code class="docutils literal notranslate"><span class="pre">tex</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#universal-import-line"><code class="docutils literal notranslate"><span class="pre">universal_import_line</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#style"><code class="docutils literal notranslate"><span class="pre">style</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#window-position"><code class="docutils literal notranslate"><span class="pre">window_position</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#window-monitor"><code class="docutils literal notranslate"><span class="pre">window_monitor</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#full-screen"><code class="docutils literal notranslate"><span class="pre">full_screen</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#break-into-partial-movies"><code class="docutils literal notranslate"><span class="pre">break_into_partial_movies</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#camera-resolutions"><code class="docutils literal notranslate"><span class="pre">camera_resolutions</span></code></a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="documentation/custom_config.html#fps"><code class="docutils literal notranslate"><span class="pre">fps</span></code></a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
<div class="toctree-wrapper compound">
|
||
<p><span class="caption-text">Development</span></p>
|
||
<ul>
|
||
<li class="toctree-l1"><a class="reference internal" href="development/changelog.html">Changelog</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/changelog.html#unreleased">Unreleased</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/changelog.html#v1-6-1">v1.6.1</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/changelog.html#v1-6-0">v1.6.0</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/changelog.html#v1-5-0">v1.5.0</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/changelog.html#v1-4-1">v1.4.1</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/changelog.html#v1-4-0">v1.4.0</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/changelog.html#v1-3-0">v1.3.0</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/changelog.html#v1-2-0">v1.2.0</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/changelog.html#v1-1-0">v1.1.0</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="development/contributing.html">Contributing</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/contributing.html#how-to-build-this-documentation">How to build this documentation</a></li>
|
||
</ul>
|
||
</li>
|
||
<li class="toctree-l1"><a class="reference internal" href="development/about.html">About</a><ul>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/about.html#about-manim">About Manim</a></li>
|
||
<li class="toctree-l2"><a class="reference internal" href="development/about.html#about-this-documentation">About this documentation</a></li>
|
||
</ul>
|
||
</li>
|
||
</ul>
|
||
</div>
|
||
</section>
|
||
|
||
</article>
|
||
<footer>
|
||
|
||
<div class="related-pages">
|
||
<a class="next-page" href="getting_started/installation.html">
|
||
<div class="page-info">
|
||
<div class="context">
|
||
<span>Next</span>
|
||
</div>
|
||
<div class="title">Installation</div>
|
||
</div>
|
||
<svg><use href="#svg-arrow-right"></use></svg>
|
||
</a>
|
||
|
||
</div>
|
||
|
||
<div class="related-information">
|
||
<span class="copyright">Copyright © - This document has been placed in the public domain.</span> |
|
||
Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using
|
||
<a class="muted-link" href="https://pradyunsg.me">@pradyunsg</a>'s
|
||
<a href="https://github.com/pradyunsg/furo">Furo theme</a>.
|
||
</div>
|
||
|
||
</footer>
|
||
</div>
|
||
<aside class="toc-drawer no-toc">
|
||
|
||
|
||
|
||
</aside>
|
||
</main>
|
||
</div>
|
||
</body>
|
||
</html> |