This is new feature of `sphinxext-opengraph` which will automatically
generate social cards for the documentation. This is a new feature and
it is not enabled is there is a custom `ogp_image` defined, which we
do. Remove it and also make sure it adds our logo to the social cards.
* move tutorials -> tutorials_guide
* change title in tutorials_guides
* rename: a_deeper_look -> output_and_config
* splitting Tutorials
* reorder index (sidebar), move some top level sections elsewhere
* rename some tutorials
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* replace recommonmark with rest for rendering md files
* fixed broken references
* fixed **all** warnings and errors during docbuild
* faq: help, more structure for landing page
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* fix deprecation tests
* prepare some sort of skeleton for installation faq
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* ensure that pip from poetry venv is used in pipeline
* added myst-parser as dev dependency
* remove fixed sphinx version from requirement.txt, don't re-install dependencies
* move and improve versions and troubleshooting content to FAQ
* resolve broken references
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* help blacken-docs
* new: navigating the docs
* make different versions question more prominent
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* fixed order of tutorials
* added explicit references to building blocks and quickstart tutorial
* docs -> doc
* change a page-reference to a paragraph-reference
* pypi manimlib, split answer regarding chocolatey failing
* added a note on #beginner-resources
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* use :pr: directive in changelog script
* change hardcoded links to PRs + issues to extlinks
* adapt extlink formatting
* fixed warning about bullet list
* improved formatting of an admonition, tried to fix section not expected (unsuccessful)
* Refactored docstrings in manim.mobject.geometry.arc
* Ignore opengl docs as it causes build failure
* Refactored docstrings in manim.mobject.geometry.boolean_ops
* Refactored docstrings in manim.mobject.geometry.line
* Removed unnecessary new lines
* point cannot be None.
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
* Revert "Ignore opengl docs as it causes build failure"
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
* Remove unused imports
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Removed non pytest imports from tests
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Remove unused pytest imports
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* re-added removed pass statements
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
* Future Annotations
* Delete template_twitter_post.py
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Apply suggestions from code review
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Fixed broken RTD
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Attempt to use CI to update translations
* try again
* runs on ubuntu latest
* Try to fix
* again
* try to use PR branch
* that didn't work
* will this work?
* Revert "will this work?"
This reverts commit 1e6543a77f.
* Try a different action
* fix attempt
* another attempt
* Revert "another attempt"
This reverts commit 8965000ac3.
* try again
* automatically generate list of all flags
* remove unrelated change
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* specify dep
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Update tutorial
Move CLI stuff to the top since it's the most important, slight rewrite, some copyediting
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* slight rephrasing
* make underline long enough
* Revert "Merge branch 'main' into command-output"
This reverts commit e6a9d457d3, reversing
changes made to 3f0137a690.
* Revert "Revert "Merge branch 'main' into command-output""
This reverts commit c823c6eb8f.
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* Perparing for internationalization
* On my way to i18n
* Making initial .pot
* Apply translations in fr
review completed for the source file '/docs/i18n/gettext/examples/camera_settings.pot'
on the 'fr' language.
* Apply translations in fr
review completed for the source file '/docs/i18n/gettext/examples/camera_settings.pot'
on the 'fr' language.
* Added some languages and changing files
* Removing translations, keeping only en
* Updating the commit history so docs are redownloaded
* Adding a bit of texts to add contributing.rst
* Apply translations in fr
at least 5% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/reference/manim.mobject.geometry.CubicBezier.po'
on the 'fr' language.
Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format
* Apply translations in fr
at least 5% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/reference/manim.mobject.types.vectorized_mobject.po'
on the 'fr' language.
Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format
* Translate /docs/i18n/en/LC_MESSAGES/index.po in fr
at least 15% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/index.po'
on the 'fr' language.
Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format
* Apply translations in fr
at least 15% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/reference/manim.mobject.geometry.CubicBezier.po'
on the 'fr' language.
Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format
* Apply translations in fr
at least 15% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/reference/manim.mobject.types.vectorized_mobject.po'
on the 'fr' language.
Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format
* Modified the Makefile a bit
* Added a first script to strip untranslatable content out
* Added some stripping code that needs to be re-worked.
* Finished the awk script. Commented it (a little gift to my future self).
Still need to test the generated files
Also removed the gettext folder from .gitignore
* Added folders in the .gitignore and comments to the awk script
* Pof, added the readyForTranslation file
* Removed french translations, hoping transifex will reset them
* Modified the files to trigger transifex changes
* Made the comment made by stripUntranslatable compatible with .po files syntax
* Tried another fix
* Another one bites the dust
* Why the reason is not necessary to involve ?
* Fixed .... i think
* Translate /docs/i18n/en/LC_MESSAGES/index.po in fr
at least 1% reviewed for the source file '/docs/i18n/en/LC_MESSAGES/index.po'
on the 'fr' language.
Manual sync of partially translated files: untranslated content is included with an empty translation or source language content depending on file format
* Added a paragraph in the docs explaining how to translate
* Changed the contributing a bit, thanks jpitz
* Tweaked the docs part a bit more
* Fixed a link and updated i18n
* REREREupdated the link
* How did i get my driving licence ?
* Little test about i18n build
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* New internationalized files.
* Corrected some grammar errors. Whoops.
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* Fixed typo in awk file comments.
* Fix the precommit issues.
* Apply suggestions from code review - Rewrote parts of the contributing text.
Co-authored-by: Darylgolden <darylgolden@gmail.com>
* Add link to discord server in translation.rst
* Suppression des en-tête inutiles des fichiers PO.
* Changed i18nService role to TranslationAdmin
* Translate /docs/i18n/en/LC_MESSAGES/index.po in fr
reviewed for the source file '/docs/i18n/en/LC_MESSAGES/index.po'
on the 'fr' language.
* Renamed the internationalization doc file. + Now every translatable string is sent to translation.
* Minor copyedit suggested by @Darylgolden
Co-authored-by: transifex-integration[bot] <43880903+transifex-integration[bot]@users.noreply.github.com>
Co-authored-by: Mysaa <mysaa@bernard.com.de>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: GameDungeon <60719255+GameDungeon@users.noreply.github.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
* fix: Updates year to 2021
Updates year in conf.py to correct year in the footer of the documentation.
Would resolve Issue https://github.com/ManimCommunity/manim/issues/1709 if merged
* fix: Updates year to 2020-2021 in docs
* test
* revert test changes
* add inheritance map
* Configure Graph to fit dark theme
* Add inheritance graphs to each section in reference
* Responsive color scheme
* remove unnecessary comment
* remove more stuff from testing
* and more still
* Update docs/source/_static/responsiveSvg.js
Co-authored-by: Naveen M K <naveen@syrusdark.website>
* Add graphviz explanation to docs
* add background color fix for chrome
* Add subheadings
* Chnaged Headings to singular and bold
Apply suggestions from code review
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
* prototype: switch from guzzle-sphinx-theme to furo
* try workaround for displaying navbar elements
* more specific css targeting
* further color adjustments
* manim-example block: larger font size
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
* remove unused import
* increase font size for references
* fix hover colors
* html_title with explicit version
* [pre-commit.ci] auto fixes from pre-commit.com hooks
for more information, see https://pre-commit.ci
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
* Fixed flake8 in files outside of manim/manim
* Removed linter/formatter workflows
* Small update to pre-commit in contributing guideline
* Better English/grammar in doc
* Refactored file architecture of graphical tests
* removed tests_cache now useless
* added show_diff helper flag
* updated test data for TextMobjecttest
* refactored set_test_scene
* removed useless imports
* added video comparison tools
* improved tests helpers for devs
* added small video tests (provisionnal)
* small changes and cleanup
* RUN BLACK SIR YES SIR
* removed unused imports
* improved docs
* Apply suggestions from code review
Co-authored-by: Leo Torres <dleonardotn@gmail.com>
* updated tests from master.
* RUN BLACK SIR YES SIR
* fixed logging tests
* fixed test name
* rgb(0,0,0)
* fixed tests
* changed .npy data to fix test (hopefully)
* removed bad control data.
* aaand re added control data
* Regenerate Reference data for TextMobject and Text tests.
* Turn off fast-failing to see if tests pass anywhere
* Use shell mode for logging test.
(Fixes the failing logging test)
* Merge branch 'master' into refactor-tests
* Add OS Specific control data for Tex[t] tests on MacOS, Windows
* Use old TextMobject reference data.
* Add reference data for Linux.
* Use reference data from Ubuntu for Linux tests.
* Use @CorvidCanine's Text data and @leotrs's Tex[t]Mobject data.
* removed hash comparison in video tests.
* updated control data
* updated helpers
* removed useless comment
* removed test_writing
* updated tests
* renamed tests
* fixed tests
* Re-add fail-fast
* Apply suggestions from code review
Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
* small docs mistake
* Update tests/utils/video_tester.py
Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Leo Torres <dleonardotn@gmail.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
Co-authored-by: Hugues Devimeux <hugues.devimeux@gmail.com>
Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
* add some module docstrings
* add some breathing room in the generated autosummaries
* edit template so it generates cleaner output
* document add and remove
* document new conf.py option
* updates from code review
Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>
Co-authored-by: Aathish Sivasubrahmanian <aathish04@gmail.com>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
* add output of manim -h to the documentation, as a poor man documentation of CLI arguments
* document config system and general changes in the description of each command line flag
* run black
* MacOS
* update
* Add configuration.rst back to the toctree. Add the contributing guidelines, which is just a symlink to the main repository\'s contributing.md file.
* add the symlinks
* fix length of underlines
Co-authored-by: Pg Biel <9021226+PgBiel@users.noreply.github.com>