mirror of
https://github.com/3b1b/manim.git
synced 2025-11-15 22:37:46 +00:00
clean up docs
This commit is contained in:
Devin Neal
parent
4447bbd016
commit
9fa350d906
26 changed files with 109 additions and 823 deletions
|
|
@ -4,8 +4,8 @@
|
|||
# You can set these variables from the command line.
|
||||
SPHINXOPTS =
|
||||
SPHINXBUILD = sphinx-build
|
||||
SOURCEDIR = .
|
||||
BUILDDIR = _build
|
||||
SOURCEDIR = source
|
||||
BUILDDIR = build
|
||||
|
||||
# Put it first so that "make" without argument is like "make help".
|
||||
help:
|
||||
|
|
|
|||
|
|
@ -1,82 +0,0 @@
|
|||
``animation`` --- Making things move
|
||||
====================================
|
||||
|
||||
``animation.animation``
|
||||
--------------------------
|
||||
|
||||
.. automodule:: animation.animation
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``animation.composition``
|
||||
----------------------------
|
||||
|
||||
.. automodule:: animation.composition
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``animation.creation``
|
||||
-------------------------
|
||||
|
||||
.. automodule:: animation.creation
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``animation.indication``
|
||||
---------------------------
|
||||
|
||||
.. automodule:: animation.indication
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``animation.movement``
|
||||
-------------------------
|
||||
|
||||
.. automodule:: animation.movement
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``animation.numbers``
|
||||
------------------------
|
||||
|
||||
.. automodule:: animation.numbers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``animation.rotation``
|
||||
-------------------------
|
||||
|
||||
.. automodule:: animation.rotation
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``animation.specialized``
|
||||
----------------------------
|
||||
|
||||
.. automodule:: animation.specialized
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``animation.transform``
|
||||
--------------------------
|
||||
|
||||
.. automodule:: animation.transform
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``animation.update``
|
||||
-----------------------
|
||||
|
||||
.. automodule:: animation.update
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,42 +0,0 @@
|
|||
``camera`` --- Create Images
|
||||
============================
|
||||
|
||||
``camera.camera``
|
||||
--------------------
|
||||
|
||||
.. automodule:: camera.camera
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``camera.mapping_camera``
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: camera.mapping_camera
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``camera.moving_camera``
|
||||
----------------------------
|
||||
|
||||
.. automodule:: camera.moving_camera
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``camera.multi_camera``
|
||||
---------------------------
|
||||
|
||||
.. automodule:: camera.multi_camera
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``camera.three_d_camera``
|
||||
------------------------------
|
||||
|
||||
.. automodule:: camera.three_d_camera
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
184
docs/conf.py
184
docs/conf.py
|
|
@ -1,184 +0,0 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
#
|
||||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file does only contain a selection of the most common options. For a
|
||||
# full list see the documentation:
|
||||
# http://www.sphinx-doc.org/en/master/config
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
import sys
|
||||
import os
|
||||
sys.path.insert(0, os.path.abspath(".."))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'manim'
|
||||
copyright = '2018, 3Blue1Brown, EulerTour'
|
||||
author = '3Blue1Brown, EulerTour'
|
||||
|
||||
# The short X.Y version
|
||||
version = ''
|
||||
# The full version, including alpha/beta/rc tags
|
||||
release = '0.1'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# If your documentation needs a minimal Sphinx version, state it here.
|
||||
#
|
||||
# needs_sphinx = '1.0'
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.autodoc',
|
||||
'sphinx.ext.coverage',
|
||||
'sphinx.ext.mathjax',
|
||||
'sphinx.ext.viewcode',
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# The suffix(es) of source filenames.
|
||||
# You can specify multiple suffix as a list of string:
|
||||
#
|
||||
# source_suffix = ['.rst', '.md']
|
||||
source_suffix = '.rst'
|
||||
|
||||
# The master toctree document.
|
||||
master_doc = 'index'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
|
||||
|
||||
# The name of the Pygments (syntax highlighting) style to use.
|
||||
pygments_style = None
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
# documentation.
|
||||
#
|
||||
html_theme_options = {
|
||||
'collapse_navigation': False,
|
||||
}
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
||||
# Custom sidebar templates, must be a dictionary that maps document names
|
||||
# to template names.
|
||||
#
|
||||
# The default sidebars (for documents that don't match any pattern) are
|
||||
# defined by theme itself. Builtin themes are using these templates by
|
||||
# default: ``['localtoc.html', 'relations.html', 'sourcelink.html',
|
||||
# 'searchbox.html']``.
|
||||
#
|
||||
# html_sidebars = {}
|
||||
|
||||
|
||||
# -- Options for HTMLHelp output ---------------------------------------------
|
||||
|
||||
# Output file base name for HTML help builder.
|
||||
htmlhelp_basename = 'manimdoc'
|
||||
|
||||
|
||||
# -- Options for LaTeX output ------------------------------------------------
|
||||
|
||||
latex_elements = {
|
||||
# The paper size ('letterpaper' or 'a4paper').
|
||||
#
|
||||
# 'papersize': 'letterpaper',
|
||||
|
||||
# The font size ('10pt', '11pt' or '12pt').
|
||||
#
|
||||
# 'pointsize': '10pt',
|
||||
|
||||
# Additional stuff for the LaTeX preamble.
|
||||
#
|
||||
# 'preamble': '',
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#
|
||||
# 'figure_align': 'htbp',
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'manim.tex', 'manim Documentation',
|
||||
'3Blue1Brown, EulerTour', 'manual'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for manual page output ------------------------------------------
|
||||
|
||||
# One entry per manual page. List of tuples
|
||||
# (source start file, name, description, authors, manual section).
|
||||
man_pages = [
|
||||
(master_doc, 'manim', 'manim Documentation',
|
||||
[author], 1)
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Texinfo output ----------------------------------------------
|
||||
|
||||
# Grouping the document tree into Texinfo files. List of tuples
|
||||
# (source start file, target name, title, author,
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'manim', 'manim Documentation',
|
||||
author, 'manim', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
]
|
||||
|
||||
|
||||
# -- Options for Epub output -------------------------------------------------
|
||||
|
||||
# Bibliographic Dublin Core info.
|
||||
epub_title = project
|
||||
|
||||
# The unique identifier of the text. This can be a ISBN number
|
||||
# or the project homepage.
|
||||
#
|
||||
# epub_identifier = ''
|
||||
|
||||
# A unique identification for the text.
|
||||
#
|
||||
# epub_uid = ''
|
||||
|
||||
# A list of files that should not be packed into the epub file.
|
||||
epub_exclude_files = ['search.html']
|
||||
|
||||
|
||||
# -- Extension configuration -------------------------------------------------
|
||||
|
|
@ -1,34 +0,0 @@
|
|||
``continual_animation`` --- Animations in the Background
|
||||
========================================================
|
||||
|
||||
``continual_animation.continual_animation``
|
||||
------------------------------------------------
|
||||
|
||||
.. automodule:: continual_animation.continual_animation
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``continual_animation.from_animation``
|
||||
-------------------------------------------
|
||||
|
||||
.. automodule:: continual_animation.from_animation
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``continual_animation.numbers``
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: continual_animation.numbers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``continual_animation.update``
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: continual_animation.update
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
.. manim documentation master file, created by
|
||||
sphinx-quickstart on Sun Sep 23 10:43:32 2018.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
manim
|
||||
=====
|
||||
|
||||
``manim`` is an animation engine for explanatory math videos. It uses Python to
|
||||
make creating precise 2D animations simple and easy.
|
||||
|
||||
.. toctree::
|
||||
:caption: Contents:
|
||||
:maxdepth: 2
|
||||
|
||||
about
|
||||
install
|
||||
getting_started
|
||||
|
||||
.. toctree::
|
||||
:caption: Module Index:
|
||||
:maxdepth: 2
|
||||
|
||||
mobject
|
||||
animation
|
||||
continual_animation
|
||||
scene
|
||||
camera
|
||||
utils
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
|
||||
|
||||
|
|
@ -1,18 +0,0 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
This fork of Manim runs on python 3.7 only. Earlier versions of python are not
|
||||
supported. You can install the python dependencies with ``pip install -r
|
||||
requirements.txt``.
|
||||
|
||||
manim relies on system libraries you will need to install on your operating
|
||||
system:
|
||||
|
||||
* ffmpeg
|
||||
* latex
|
||||
* sox
|
||||
|
||||
The dockerfile is (should be) the definitive source for everything required by
|
||||
``manim``.
|
||||
|
||||
|
||||
|
|
@ -7,8 +7,8 @@ REM Command file for Sphinx documentation
|
|||
if "%SPHINXBUILD%" == "" (
|
||||
set SPHINXBUILD=sphinx-build
|
||||
)
|
||||
set SOURCEDIR=.
|
||||
set BUILDDIR=_build
|
||||
set SOURCEDIR=source
|
||||
set BUILDDIR=build
|
||||
|
||||
if "%1" == "" goto help
|
||||
|
||||
|
|
|
|||
134
docs/mobject.rst
134
docs/mobject.rst
|
|
@ -1,134 +0,0 @@
|
|||
``mobject`` --- Mathematical Objects
|
||||
====================================
|
||||
|
||||
Subpackages
|
||||
-----------
|
||||
|
||||
.. toctree::
|
||||
|
||||
mobject.svg
|
||||
mobject.types
|
||||
|
||||
``mobject.component`` --- Customizable Mobjects
|
||||
-----------------------------------------------
|
||||
|
||||
.. automodule:: mobject.component
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.coordinate_systems``
|
||||
------------------------------
|
||||
|
||||
.. automodule:: mobject.coordinate_systems
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.frame``
|
||||
--------------------
|
||||
|
||||
.. automodule:: mobject.frame
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.functions`` --- VMobjects from Functions
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: mobject.functions
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.geometry`` --- Geometric Shapes
|
||||
-----------------------------------------
|
||||
|
||||
.. automodule:: mobject.geometry
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.matrix`` --- Matrices
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: mobject.matrix
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.mobject`` --- Mathematical Objects
|
||||
--------------------------------------------
|
||||
|
||||
.. automodule:: mobject.mobject
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
:member-order: bysource
|
||||
:exclude-members:
|
||||
__init__,
|
||||
CONFIG
|
||||
|
||||
``mobject.number_line`` --- Number Lines
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: mobject.number_line
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.numbers`` --- Numbers
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: mobject.numbers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.probability`` --- Probaility Visualizations
|
||||
-----------------------------------------------------
|
||||
|
||||
.. automodule:: mobject.probability
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.shape_matchers`` --- Fit another Mobject
|
||||
--------------------------------------------------
|
||||
|
||||
.. automodule:: mobject.shape_matchers
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.three_d_shading_utils``
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: mobject.three_d_shading_utils
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.three_d_utils``
|
||||
------------------------------
|
||||
|
||||
.. automodule:: mobject.three_d_utils
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.three_dimensions``
|
||||
--------------------------------
|
||||
|
||||
.. automodule:: mobject.three_dimensions
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``mobject.value_tracker``
|
||||
-----------------------------
|
||||
|
||||
.. automodule:: mobject.value_tracker
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,46 +0,0 @@
|
|||
mobject.svg package
|
||||
===================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
mobject.svg.brace module
|
||||
------------------------
|
||||
|
||||
.. automodule:: mobject.svg.brace
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
mobject.svg.drawings module
|
||||
---------------------------
|
||||
|
||||
.. automodule:: mobject.svg.drawings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
mobject.svg.svg\_mobject module
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: mobject.svg.svg_mobject
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
mobject.svg.tex\_mobject module
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: mobject.svg.tex_mobject
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: mobject.svg
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,38 +0,0 @@
|
|||
mobject.types package
|
||||
=====================
|
||||
|
||||
Submodules
|
||||
----------
|
||||
|
||||
mobject.types.image\_mobject module
|
||||
-----------------------------------
|
||||
|
||||
.. automodule:: mobject.types.image_mobject
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
mobject.types.point\_cloud\_mobject module
|
||||
------------------------------------------
|
||||
|
||||
.. automodule:: mobject.types.point_cloud_mobject
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
mobject.types.vectorized\_mobject module
|
||||
----------------------------------------
|
||||
|
||||
.. automodule:: mobject.types.vectorized_mobject
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Module contents
|
||||
---------------
|
||||
|
||||
.. automodule:: mobject.types
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -1,7 +0,0 @@
|
|||
mobject
|
||||
=======
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 4
|
||||
|
||||
mobject
|
||||
|
|
@ -1,74 +0,0 @@
|
|||
``scene`` --- Organize Animations
|
||||
=================================
|
||||
|
||||
``scene.graph_scene``
|
||||
-------------------------
|
||||
|
||||
.. automodule:: scene.graph_scene
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``scene.moving_camera_scene``
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: scene.moving_camera_scene
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``scene.reconfigurable_scene``
|
||||
----------------------------------
|
||||
|
||||
.. automodule:: scene.reconfigurable_scene
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``scene.sample_space_scene``
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: scene.sample_space_scene
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``scene.scene``
|
||||
------------------
|
||||
|
||||
.. automodule:: scene.scene
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``scene.scene_from_video``
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: scene.scene_from_video
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``scene.three_d_scene``
|
||||
----------------------------
|
||||
|
||||
.. automodule:: scene.three_d_scene
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``scene.vector_space_scene``
|
||||
---------------------------------
|
||||
|
||||
.. automodule:: scene.vector_space_scene
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``scene.zoomed_scene``
|
||||
--------------------------
|
||||
|
||||
.. automodule:: scene.zoomed_scene
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
|
@ -3,9 +3,9 @@ About
|
|||
|
||||
Animating technical concepts is traditionally pretty tedious, since it can be
|
||||
difficult to make the animations precise enough to convey them accurately.
|
||||
``manim`` uses Python to generate animations programmatically, which makes it
|
||||
``Manim`` uses Python to generate animations programmatically, which makes it
|
||||
possible to specify exactly how each one should run.
|
||||
|
||||
This project is still very much a work in progress, but I hope the the
|
||||
information here will make it easier for newcomers to get started using
|
||||
``manim``.
|
||||
``Manim``.
|
||||
52
docs/source/conf.py
Normal file
52
docs/source/conf.py
Normal file
|
|
@ -0,0 +1,52 @@
|
|||
# Configuration file for the Sphinx documentation builder.
|
||||
#
|
||||
# This file only contains a selection of the most common options. For a full
|
||||
# list see the documentation:
|
||||
# http://www.sphinx-doc.org/en/master/config
|
||||
|
||||
# -- Path setup --------------------------------------------------------------
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
# documentation root, use os.path.abspath to make it absolute, like shown here.
|
||||
#
|
||||
# import os
|
||||
# import sys
|
||||
# sys.path.insert(0, os.path.abspath('.'))
|
||||
|
||||
|
||||
# -- Project information -----------------------------------------------------
|
||||
|
||||
project = 'Manim'
|
||||
copyright = '2019, EulerTour'
|
||||
author = 'EulerTour'
|
||||
|
||||
|
||||
# -- General configuration ---------------------------------------------------
|
||||
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
# This pattern also affects html_static_path and html_extra_path.
|
||||
exclude_patterns = []
|
||||
|
||||
|
||||
# -- Options for HTML output -------------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
#
|
||||
html_theme = 'sphinx_rtd_theme'
|
||||
|
||||
# Add any paths that contain custom static files (such as style sheets) here,
|
||||
# relative to this directory. They are copied after the builtin static files,
|
||||
# so a file named "default.css" will overwrite the builtin "default.css".
|
||||
html_static_path = ['_static']
|
||||
|
|
@ -12,7 +12,7 @@ how ``manim`` is used, but the examples won't run on the latest version of
|
|||
:caption: Contents:
|
||||
:maxdepth: 2
|
||||
|
||||
getting_started/learning_by_example
|
||||
getting_started/mathematical_objects
|
||||
getting_started/animating_mobjects
|
||||
getting_started/making_a_scene
|
||||
learning_by_example
|
||||
mathematical_objects
|
||||
animating_mobjects
|
||||
making_a_scene
|
||||
23
docs/source/index.rst
Normal file
23
docs/source/index.rst
Normal file
|
|
@ -0,0 +1,23 @@
|
|||
.. Manim documentation master file, created by
|
||||
sphinx-quickstart on Mon May 27 14:19:19 2019.
|
||||
You can adapt this file completely to your liking, but it should at least
|
||||
contain the root `toctree` directive.
|
||||
|
||||
Welcome to Manim's documentation!
|
||||
=================================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
about
|
||||
installation/index
|
||||
getting_started/index
|
||||
|
||||
|
||||
Indices and tables
|
||||
==================
|
||||
|
||||
* :ref:`genindex`
|
||||
* :ref:`modindex`
|
||||
* :ref:`search`
|
||||
12
docs/source/installation/index.rst
Normal file
12
docs/source/installation/index.rst
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
Installation
|
||||
============
|
||||
|
||||
Instructions on installing Manim
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:caption: Contents:
|
||||
|
||||
linux
|
||||
mac
|
||||
windows
|
||||
4
docs/source/installation/linux.rst
Normal file
4
docs/source/installation/linux.rst
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
Linux
|
||||
=====
|
||||
|
||||
A stub for linux installation
|
||||
4
docs/source/installation/mac.rst
Normal file
4
docs/source/installation/mac.rst
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
Mac
|
||||
===
|
||||
|
||||
A stub for mac installation
|
||||
4
docs/source/installation/windows.rst
Normal file
4
docs/source/installation/windows.rst
Normal file
|
|
@ -0,0 +1,4 @@
|
|||
Windows
|
||||
=======
|
||||
|
||||
A stub for windows installation
|
||||
116
docs/utils.rst
116
docs/utils.rst
|
|
@ -1,116 +0,0 @@
|
|||
``utils`` --- Make Common Tasks Easier
|
||||
======================================
|
||||
|
||||
``utils.bezier module``
|
||||
-------------------
|
||||
|
||||
.. automodule:: utils.bezier
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.color module``
|
||||
------------------
|
||||
|
||||
.. automodule:: utils.color
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.config_ops module``
|
||||
------------------------
|
||||
|
||||
.. automodule:: utils.config_ops
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.images module``
|
||||
-------------------
|
||||
|
||||
.. automodule:: utils.images
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.iterables module``
|
||||
----------------------
|
||||
|
||||
.. automodule:: utils.iterables
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.output_directory_getters module``
|
||||
---------------------------------------
|
||||
|
||||
.. automodule:: utils.output_directory_getters
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.paths module``
|
||||
------------------
|
||||
|
||||
.. automodule:: utils.paths
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.rate_functions module``
|
||||
----------------------------
|
||||
|
||||
.. automodule:: utils.rate_functions
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.save module``
|
||||
-----------------
|
||||
|
||||
.. automodule:: utils.save
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.simple_functions module``
|
||||
------------------------------
|
||||
|
||||
.. automodule:: utils.simple_functions
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.sounds module``
|
||||
-------------------
|
||||
|
||||
.. automodule:: utils.sounds
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.space_ops module``
|
||||
-----------------------
|
||||
|
||||
.. automodule:: utils.space_ops
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.strings module``
|
||||
--------------------
|
||||
|
||||
.. automodule:: utils.strings
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
``utils.tex_file_writing module``
|
||||
-------------------------------
|
||||
|
||||
.. automodule:: utils.tex_file_writing
|
||||
:members:
|
||||
:undoc-members:
|
||||
:show-inheritance:
|
||||
|
||||
|
||||
Loading…
Add table
Reference in a new issue