Skip to content

armgit / manim

Public Imported from GitHub
0

A community-maintained Python framework for creating mathematical animations.

Added a page for internals which links to our Github wiki (#2549)

Darylgoldenf5b6e00a6e7d
diff --git a/docs/source/index.rst b/docs/source/index.rst
index 144a84820..1e1ac1836 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -29,6 +29,7 @@ context, instructions on how to cite a particular release can be found
reference
plugins
reporting_bugs
+ internals
contributing
conduct
diff --git a/docs/source/internals.rst b/docs/source/internals.rst
new file mode 100644
index 000000000..aa83f809e
--- /dev/null
+++ b/docs/source/internals.rst
@@ -0,0 +1,10 @@
+Internal structure
+==================
+
+Efforts to document the internal structure of Manim is ongoing on our
+`wiki <https://github.com/ManimCommunity/manim/wiki/Developer-documentation-(WIP)>`_.
+
+Keep in mind that since this is a work in progress, the information you find may be
+incomplete, outdated or even wrong. Still, it should serve as a good starting point.
+The wiki is open for anyone to edit, feel free to add information or even questions
+directly on the wiki pages.