Skip to content

Commit c2f6638

Browse files
docs: improve installation guide and restructure documentation configuration
- Updated Installation section with clearer step-by-step instructions - Improved project structure explanation - Refactored configuration documentation for better clarity - Reorganized headings and subsections for consistency - Fixed formatting and minor inconsistencies
1 parent e7787d7 commit c2f6638

7 files changed

Lines changed: 533 additions & 401 deletions

File tree

docs/requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
Sphinx==3.0.3
1+
Sphinx>=4.5.0
22
sphinx-copybutton
3-
furo==2020.10.5b9
4-
Jinja2
3+
furo
4+
Jinja2

docs/source/development/about.rst

Lines changed: 30 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -4,28 +4,43 @@ About
44
About Manim
55
-----------
66

7-
Manim is an animation engine for explanatory math videos.
8-
You can use it to make math videos (or other fields) like 3Blue1Brown.
7+
Manim is a powerful animation engine designed for creating
8+
**explanatory math videos**.
9+
It is widely used to create videos similar to those of 3Blue1Brown,
10+
but it can also be applied to other domains that require precise
11+
and visually appealing animations.
912

10-
There are mainly two versions here:
13+
There are mainly **two versions** of Manim:
1114

12-
- `3b1b/manim <https://github.com/3b1b/manim>`_ : Maintained by Grant Sanderson of 3Blue1Brown.
15+
- `3b1b/manim <https://github.com/3b1b/manim>`__
16+
17+
Maintained by Grant Sanderson of 3Blue1Brown.
1318

14-
Using OpenGL and its GLSL language to use GPU for rendering. It has higher efficiency,
15-
faster rendering speed, and supports real-time rendering and interaction.
19+
- Uses **OpenGL** and its **GLSL language** to leverage the GPU.
20+
- Offers higher efficiency, faster rendering, and real-time interaction.
21+
- Best suited for high-quality production-ready videos.
1622

17-
- `ManimCommunity/manim <https://github.com/ManimCommunity/manim>`_ : Maintained by Manim Community Dev Team.
23+
- `ManimCommunity/manim <https://github.com/ManimCommunity/manim>`__
24+
25+
Maintained by the Manim Community Development Team.
1826

19-
Using multiple backend rendering. There is better documentation and
20-
a more open contribution community.
27+
- Uses multiple backend rendering options.
28+
- Provides better documentation and open contribution workflow.
29+
- Ideal for learners and educators.
2130

22-
About this documentation
31+
About this Documentation
2332
------------------------
2433

25-
This documentation is based on the version in `3b1b/manim <https://github.com/3b1b/manim>`_.
26-
Created by `TonyCrane <https://github.com/TonyCrane>`_ ("鹤翔万里" in Chinese) and in production.
34+
This documentation is primarily based on:
2735

28-
Among them, the ``manim_example_ext`` extension for Sphinx refers to
29-
`the documentation of ManimCommunity <https://docs.manim.community/>`_.
36+
`3b1b/manim <https://github.com/3b1b/manim>`__
3037

31-
If you want to contribute to manim or this document, please see: :doc:`contributing`
38+
- Created by `TonyCrane <https://github.com/TonyCrane>`__.
39+
- Continuously updated for clarity and accuracy.
40+
41+
.. note::
42+
43+
Some features such as ``manim_example_ext`` are inspired by
44+
the `ManimCommunity documentation <https://docs.manim.community/>`__.
45+
46+
If you want to contribute, please see :doc:`contributing`.
Lines changed: 49 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,81 @@
11
Contributing
22
============
33

4-
Accept any contribution you make :)
4+
We welcome and appreciate any contributions you make to Manim! :)
55

6-
- **Contribute to the manim source code**:
6+
Contributing to the Source Code
7+
-------------------------------
78

8-
Please fork to your own repository and make changes, submit a pull request, and fill in
9-
the motivation for the change following the instructions in the template. We will check
10-
your pull request in detail (this usually takes a while, please be patient)
9+
- **Fork the repository** to your own GitHub account.
10+
- Make your changes locally.
11+
- Submit a **pull request** to the main repository.
12+
- Fill in the **motivation for your change** following the instructions in the provided template.
1113

12-
- **Contribute to the documentation**:
14+
.. note::
1315

14-
Also submit a pull request and write down the main changes.
16+
Pull requests will be reviewed in detail. This process may take some time, so please be patient.
1517

16-
- **If you find a bug in the code**:
18+
Contributing to the Documentation
19+
---------------------------------
1720

18-
Please open an issue and fill in the found problem and your environment according
19-
to the template. (But please note that if you think this problem is just a problem
20-
of yourself, rather than a problem of source code, it is recommended that you ask a
21-
question in the `Q&A category <https://github.com/3b1b/manim/discussions/categories/q-a>`_
22-
of the discussion page)
21+
- Make edits to the documentation files in your fork.
22+
- Submit a **pull request** describing the main changes you made.
2323

24-
- **You are welcome to share the content you made with manim**:
24+
Reporting Bugs
25+
--------------
2526

26-
Post it in the `show and tell category <https://github.com/3b1b/manim/discussions/categories/show-and-tell>`_
27-
of the discussion page.
27+
If you find a bug in the code:
2828

29-
- **You are also welcome to share some of your suggestions and ideas**:
29+
1. Open a new **issue** in the repository.
30+
2. Describe the problem clearly.
31+
3. Include details about your **environment** (Python version, OS, Manim version, etc.) according to the issue template.
3032

31-
Post them in the `ideas category <https://github.com/3b1b/manim/discussions/categories/ideas>`_
32-
of the discussion page.
33+
.. note::
3334

34-
How to build this documentation
35-
-------------------------------
35+
If you suspect the problem is local to your setup rather than the source code, it is recommended to ask a question in the
36+
`Q&A category <https://github.com/3b1b/manim/discussions/categories/q-a>`_ of the discussion page.
37+
38+
Sharing Your Work
39+
-----------------
40+
41+
- You are welcome to share content you created using Manim.
42+
- Post it in the `Show and Tell category <https://github.com/3b1b/manim/discussions/categories/show-and-tell>`_ of the discussion page.
43+
44+
Sharing Ideas and Suggestions
45+
-----------------------------
3646

37-
- Clone the 3b1b/manim repository
47+
- Suggestions, feature requests, and ideas are encouraged!
48+
- Post them in the `Ideas category <https://github.com/3b1b/manim/discussions/categories/ideas>`_ of the discussion page.
49+
50+
How to Build the Documentation
51+
------------------------------
52+
53+
Follow these steps to build the Manim documentation locally:
54+
55+
1. **Clone the repository**
3856

3957
.. code-block:: sh
4058
4159
git clone https://github.com/3b1b/manim.git
42-
# or your own repo
43-
# git clone https://github.com/<your user name>/manim.git
60+
# Or clone your own fork
61+
# git clone https://github.com/<your-username>/manim.git
4462
cd manim
4563
46-
- Install python package dependencies
64+
2. **Install Python package dependencies**
4765

4866
.. code-block:: sh
4967
5068
pip install -r docs/requirements.txt
5169
52-
- Go to the ``docs/`` folder and build
70+
3. **Navigate to the docs folder and build HTML**
5371

5472
.. code-block:: sh
5573
5674
cd docs/
5775
make html
5876
59-
- The output document is located in ``docs/build/html/``
77+
4. **Find the built documentation**
78+
79+
The output HTML files will be located in::
80+
81+
docs/build/html/

0 commit comments

Comments
 (0)