finish development category and improve style

This commit is contained in:
Tony031218
2021-01-25 10:20:41 +08:00
parent 42c59f80c8
commit a7697095d6
9 changed files with 123 additions and 32 deletions

View File

@ -1,3 +1,11 @@
span.caption-text {
font-size: larger;
}
span.pre {
font-size: initial;
}
.highlight-python.notranslate {
margin-top: 0em;
}

View File

@ -1,3 +1,31 @@
About
=====
WIP
About Manim
-----------
Manim is an animation engine for explanatory math videos.
You can use it to make math videos (or other fields) like 3Blue1Brown.
There are mainly two versions here:
- `3b1b/manim <https://github.com/3b1b/manim>`_ : Maintained by Grant Sanderson of 3Blue1Brown.
Using OpenGL and its GLSL language to use GPU for rendering. It has higher efficiency,
faster rendering speed, and supports real-time rendering and interaction.
- `ManimCommunity/manim <https://github.com/ManimCommunity/manim>`_ : Maintained by Manim Community Dev Team.
Using cairo to use CPU for rendering. There is better documentation and
a more open contribution community.
About this documentation
------------------------
This documentation is based on the version in `3b1b/manim <https://github.com/3b1b/manim>`_.
Created by `TonyCrane <https://github.com/TonyCrane>`_ and in production.
Among them, the ``manim_example_ext`` extension for Sphinx refers to
`the documentation of ManimCommunity <https://docs.manim.community/>`_.
If you want to contribute to manim or this document, please see: :doc:`contributing`

View File

@ -1,3 +1,4 @@
Changelog
=========
WIP
No changes now.

View File

@ -0,0 +1,59 @@
Contributing
============
Accept any contribution you make :)
- **Contribute to the manim source code**:
Please fork to your own repository and make changes, submit a pull request, and fill in
the motivation for the change following the instructions in the template. We will check
your pull request in detail (this usually takes a while, please be patient)
- **Contribute to the documentation**:
Also submit a pull request and write down the main changes.
- **If you find a bug in the code**:
Please open an issue and fill in the found problem and your environment according
to the template. (But please note that if you think this problem is just a problem
of yourself, rather than a problem of source code, it is recommended that you ask a
question in the `Q&A category <https://github.com/3b1b/manim/discussions/categories/q-a>`_
of the discussion page)
- **You are welcome to share the content you made with manim**:
Post it in the `show and tell category <https://github.com/3b1b/manim/discussions/categories/show-and-tell>`_
of the discussion page.
- **You are also welcome to share some of your suggestions and ideas**:
Post them in the `ideas category <https://github.com/3b1b/manim/discussions/categories/ideas>`_
of the discussion page.
How to build this documentation
-------------------------------
- Clone the 3b1b/manim repository
.. code-block:: sh
git clone https://github.com/3b1b/manim.git
# or your own repo
# git clone https://github.com/<your user name>/manim.git
cd manim
- Install python package dependencies
.. code-block:: sh
pip install -r docs/requirements.txt
- Go to the ``docs/`` folder and build
.. code-block:: sh
cd docs/
make html
- The output document is located in ``docs/build/html/``

View File

@ -1,3 +0,0 @@
Contribution
============
WIP

View File

@ -3,10 +3,12 @@ Installation
Manim runs on Python 3.8.
System requirements are `FFmpeg <https://ffmpeg.org/>`__,
`OpenGL <https://www.opengl.org//>`__ and
`latex <https://www.latex-project.org>`__ (optional, if you want to use
LaTeX).
System requirements are
- `FFmpeg <https://ffmpeg.org/>`__
- `OpenGL <https://www.opengl.org//>`__ (included in python package ``PyOpenGL``)
- `LaTeX <https://www.latex-project.org>`__ (optional, if you want to use LaTeX)
- `cairo <https://www.cairographics.org/>`_ (included in python package ``pycairo``. optional, if you want to use ``Text`` in manim)
Directly
--------
@ -26,9 +28,9 @@ Directly (Windows)
------------------
1. `Install
FFmpeg <https://www.wikihow.com/Install-FFmpeg-on-Windows>`__.
FFmpeg <https://www.wikihow.com/Install-FFmpeg-on-Windows>`__, and make sure that its path is in the PATH environment variable.
2. Install a LaTeX distribution.
`MiKTeX <https://miktex.org/download>`__ is recommended.
`TeXLive-full <http://tug.org/texlive/>`__ is recommended.
3. Install the remaining Python packages.
.. code:: sh
@ -39,16 +41,21 @@ Directly (Windows)
python manim.py example_scenes.py OpeningManimExample
For Anaconda
----------------
------------
- Install latex as above.
- Install FFmpeg and LaTeX as above.
- Create a conda environment using
``conda env create -f environment.yml``
.. code-block:: sh
git clone https://github.com/3b1b/manim.git
cd manim
conda env create -f environment.yml
Using virtualenv and virtualenvwrapper
----------------------------------------------
--------------------------------------
After installing virtualenv and virtualenvwrapper
After installing ``virtualenv`` and ``virtualenvwrapper``
.. code:: sh

View File

@ -31,13 +31,5 @@ at `3Blue1Brown <https://www.3blue1brown.com/>`_.
:caption: Development
development/changelog
development/contribution
development/contributing
development/about
Indices and tables
==================
* :ref:`genindex`
* :ref:`search`