From 9e5f39a4a935205ed08a67221c5728df18f1cc67 Mon Sep 17 00:00:00 2001 From: TonyCrane <975062472@qq.com> Date: Mon, 14 Jun 2021 16:36:16 +0800 Subject: [PATCH] update docs --- docs/source/development/changelog.rst | 7 ++++++- docs/source/getting_started/configuration.rst | 9 ++++++++- 2 files changed, 14 insertions(+), 2 deletions(-) diff --git a/docs/source/development/changelog.rst b/docs/source/development/changelog.rst index e12aeea4..573df074 100644 --- a/docs/source/development/changelog.rst +++ b/docs/source/development/changelog.rst @@ -14,6 +14,8 @@ Fixed bugs - Fixed a bug for off-center vector fields - Had ``Mobject.match_points`` return self - Fixed chaining animation in example scenes +- Fixed the default color of tip +- Fixed a typo in ``ShowPassingFlashWithThinningStrokeWidth`` New Features ^^^^^^^^^^^^ @@ -36,4 +38,7 @@ New Features - Added :meth:`~manimlib.camera.camera.CameraFrame.reorient` for quicker changes to frame angle - Added ``units`` to :meth:`~manimlib.camera.camera.CameraFrame.set_euler_angles` - Allowed any ``VMobject`` to be passed into ``TransformMatchingTex`` -- Removed double brace convention in ``Tex`` and ``TexText`` \ No newline at end of file +- Removed double brace convention in ``Tex`` and ``TexText`` +- Added support for debugger launch +- Added CLI flag ``--config_file`` to load configuration file manually +- Added ``tip_style`` to ``tip_config`` \ No newline at end of file diff --git a/docs/source/getting_started/configuration.rst b/docs/source/getting_started/configuration.rst index 88da1bc8..eb981b19 100644 --- a/docs/source/getting_started/configuration.rst +++ b/docs/source/getting_started/configuration.rst @@ -58,6 +58,7 @@ flag abbr function ``--color COLOR`` ``-c`` Background color ``--leave_progress_bars`` Leave progress bars displayed in terminal ``--video_dir VIDEO_DIR`` directory to write video +``--config_file CONFIG_FILE`` Path to the custom configuration file ========================================================== ====== ================================================================================================================================================================================================= custom_config @@ -86,4 +87,10 @@ following the directory structure: When you enter the ``project/`` folder and run ``manimgl code.py ``, it will overwrite ``manim/default_config.yml`` with ``custom_config.yml`` -in the ``project`` folder. \ No newline at end of file +in the ``project`` folder. + +Alternatively, you can use ``--config_file`` flag in CLI to specify configuration file manually. + +.. code-block:: sh + + manimgl project/code.py --config_file /path/to/custom_config.yml \ No newline at end of file