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

* Link to wiki

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* link in sidebar

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
This commit is contained in:
Darylgolden 2022-02-19 23:48:18 +08:00 committed by GitHub
commit f5b6e00a6e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 0 deletions

View file

@ -29,6 +29,7 @@ context, instructions on how to cite a particular release can be found
reference
plugins
reporting_bugs
internals
contributing
conduct

10
docs/source/internals.rst Normal file
View file

@ -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.