Repository navigation
docs: correct custom_config keys and drop a dangling toctree entry - #2512
Open
ting-hong-shieh wants to merge 1 commit into
Open
ting-hong-shieh wants to merge 1 commit into
ting-hong-shieh wants to merge 1 commit into
Conversation
The custom configuration page named two options that do not exist in manimlib/default_config.yml, so following it produced settings manim silently ignores: - `loglevel` is spelled `log_level` (default_config.yml, read by manimlib/config.py in `log.setLevel`) - `text_alignment` is spelled `alignment`, and it sets the default alignment of `Text`, not of LaTeX (read as `text_config.alignment` in manimlib/mobject/svg/text_mobject.py) The `scene` and `text` title underlines were shorter than their titles, and docs/source/index.rst still listed `getting_started/config`, deleted in 44b7d33 back in 2022. Both raised Sphinx warnings. Also fixes four typos in surrounding prose.
ting-hong-shieh
marked this pull request as ready for review
August 19, 2026 16:25
This branch has not been deployed
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Motivation
Partially addresses #2378, which reports that the custom configuration page has drifted from the actual config format.
Two of the options it documents do not exist in
manimlib/default_config.yml. Because an unrecognised key incustom_config.ymlis simply ignored, someone following the page gets no error — the setting just never takes effect:loglevel. The real key islog_level(manimlib/default_config.yml), read inmanimlib/config.pyasconfig["log_level"].text, the page calls ittext_alignmentand describes it as "Default text alignment for LaTeX". The real key isalignment, and it is read inMarkupText.__init__astext_config.alignment, so it sets the default forText, not for LaTeX.text_alignmentdoes not appear anywhere inmanimlib/.Two smaller things showed up while building the docs:
sceneandtexttitle underlines are shorter than their titles, which Sphinx warns about.docs/source/index.rststill listsgetting_started/configin the Getting Started toctree. That file was deleted in 44b7d33 (Dec 2022), so Sphinx warns on every build.Proposed changes
docs/source/documentation/custom_config.rstloglevel→log_leveltext_alignment→alignment, with a description that matches what the key actually doessceneandtexttitle underlinesValuess,manimm,pallete,withinn) and one ungrammatical sentence underuniversal_import_linedocs/source/index.rstgetting_started/configtoctree entryDeliberately not in this PR, to keep it easy to review:
directoriessection is also out of date, in a way that needs more than a rename:output,raster_images,vector_imagesandsoundsare nested underdirectories.subdirsin the yml rather than directly underdirectories, and the two directory-tree examples still show separateimages/andvideos/folders. I would rather verify that against a real render and send it separately.vmobject,mobject,embed,resolution_options,key_bindings).Test
Code: the same build CI runs, on
master(5d107b1) and on this branch, with Python 3.12 anddocs/requirements.txt(Sphinx 9.1.0):Result:
build succeededboth times; warnings go from 9 to 6.The three that disappear are exactly the ones this PR targets:
The remaining 6 are pre-existing
toc.not_includedwarnings for the autodoc index pages underdocumentation/, untouched here.Diffing the rendered
custom_config.htmlbetween the two builds shows only the intended edits — the section structure is otherwise byte-identical, so the shorter underlines were not changing how the page rendered, only warning.One consequence worth flagging: the heading anchor changes from
#loglevelto#log-level. Nothing in this repository links to the old anchor, but an external deep link would break.