Commit graph

57 commits

Author SHA1 Message Date
Darylgolden
6018ebf445 Revert "Merge branch 'main' of https://github.com/ManimCommunity/manim"
This reverts commit e7f9d23aa7, reversing
changes made to afe91d02b6.
2023-07-31 15:29:39 +08:00
Naveen M K
a7a972bf66
docs: enable social cards (#3219)
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.
2023-04-25 13:26:35 +02:00
ciobaca
27011d648f
Fixed extlinks in docs to work with latest version of Sphinx. (#3186) 2023-03-14 23:21:39 +01:00
Benjamin Hackl
89bed0a923
disable edit on GitHub button in documentation (#2962) 2022-09-25 02:12:27 +02:00
Benjamin Hackl
48747a74d9
Refactored structure of documentation; added :doc:FAQ section <faq/index> (#2732)
* 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>
2022-05-27 08:45:31 +00:00
Darigov Research
ecce9bb9ad
Update copyright year in documentation to 2020-2022 (#2651) 2022-04-05 17:09:04 +05:30
Benjamin Hackl
a8de354101
Reduced the number of warnings during documentation build (#2603)
* 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)
2022-03-08 12:23:27 +08:00
ad_chaos
9e19f8c2d1
Refactored docstrings in mod:manim.mobject.geometry (#2560)
* 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>
2022-02-25 19:13:05 +00:00
Darylgolden
7efa2066ac
Removed unused imports (#2503)
* 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>
2022-01-30 14:31:45 +00:00
GameDungeon
daf23c9d10
Upgraded typehints (#2429)
* 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>
2022-01-20 12:26:21 +08:00
Darylgolden
ccfea0ff4a
Made improvements to the :doc:configuration tutorial (#2414)
* 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>
2022-01-06 14:31:22 +08:00
GameDungeon
c4217731e0
Added MyPy Support (#1972)
* MyPy Support

* MyPy Hook

* Removing MyPy Hook

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Delete __init__.pyi

* Delete color.pyi

* Update .mypy.ini

Co-authored-by: Christopher Besch <christopher.besch@gmx.de>

* changes

* quick fix

* MyPy Hook

* MyPy Hook

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Christopher Besch <christopher.besch@gmx.de>
2022-01-03 19:41:07 +08:00
GameDungeon
f993ee02ea
Fixed Flake8 (#2410)
* Auto Type

* Revert "Auto Type"

This reverts commit a458905369.

* Fixed Flake
2022-01-01 07:59:28 +08:00
Benjamin Hackl
dfac7a7b29
Moved `manim_directive.py to manim.utils.docbuild` (#2347)
* moved manim_directive to manim.utils

* fix dot not defined

* missed a thing for the import

* f-strings apparently display with single quotes?
2021-12-02 17:09:02 +00:00
Mysaa
065c7612a2
Prepare documentation for translation (#862)
* 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>
2021-09-24 20:17:43 +08:00
GameDungeon
94821c10d8
Flake8 Changes + Fixing Warnings (#1968)
* Warning Removal

* Flake Stuff

* HotFix

* Docs Fix

* I'm Dumb

* Docs Fix 2

* Fixing Github Requests

* Fix

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* quick fix

* Add Deprecation Warning

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Weird Pre Commit Stuff

* Quick Fix

* Quick Fix

* Fix

* Flake Fix

* [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>
2021-09-03 13:45:48 -04:00
Darylgolden
092555adc7
Made RTD apt install FFMPEG instead of installing a Python binding (#1896)
* Try to apt install ffmpeg instead

* remove symlink

* try
2021-08-12 12:48:23 +00:00
Darylgolden
ce89fa5b04
Prevented old versions of documentation from showing in search results (#1827)
* Remove everything except stable

* [pre-commit.ci] auto fixes from pre-commit.com hooks

for more information, see https://pre-commit.ci

* Update docs/source/robots.txt

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>
2021-07-25 15:07:46 +08:00
Laith Bahodi
be1e21e7e7
Improve the look of the docs. (#1594)
* the changes

* adjusted rem value

* reduce p.rubric (Example) font size

* restored code-color-backgrounds

* reduce greyness of sidebar-background, light mode

Co-authored-by: Jan-Hendrik Müller <44469195+kolibril13@users.noreply.github.com>
2021-06-24 02:19:26 -04:00
Darigov Research
2cf1f17bb3
Update copyright year in documentation to 2020-2021 (#1710)
* 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
2021-06-19 17:23:46 +08:00
Anton Ballmaier
2d2604bca9
Add inheritance diagrams to reference page (#1441)
* 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>
2021-05-06 12:31:02 +02:00
friedkeenan
49b50cfe78
Change docs to use viewcode instead of linkcode (#1297)
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-04-09 12:54:01 -07:00
Benjamin Hackl
4fc00f7318
Switch documentation from guzzle-sphinx-theme to furo (#1251)
* 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>
2021-04-08 20:18:02 -07:00
Jason Villanueva
1e049d8bd2
Fixed flake8 errors and removed linter/formatter workflows (#1278)
* 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
2021-04-07 06:14:14 -07:00
M. Eugenia Moreno
6b90fd287e
fix #1045 changes in line 118 (#1053) 2021-03-01 14:09:16 +05:30
Leo Torres
1a5b4b1fc9
Add skip-manim tag when building the docs (#796) 2020-12-01 20:08:01 +01:00
Benjamin Hackl
6a02b38a2d
Fix docbuild warning (#744)
* fix all docbuild warnings

* black
2020-11-20 23:50:40 +01:00
Benjamin Hackl
9cd777d43b
Enable rendering type hints (PEP 484) (#701)
* enable rendering of type hints

* one day, I'll remember to check for single vs. double quotes 🙃
2020-11-16 15:24:59 +01:00
Naveen M K
a9402264ab
Upgrade Pangocffi - fix ModuleNotFoundError found error (#711)
* Upgrade Pangocffi version - fix ModuleNotFoundError found error
2020-11-15 13:32:34 -05:00
Benjamin Hackl
12d7af38d1
Add links from reference manual to source code on GitHub (#703)
* add basic links from documentation to source code on github

* black
2020-11-13 22:57:27 +05:30
Benjamin Hackl
f0055a1b2a
Add shortcut for creating links to issues and PRs in the documentation (#685)
* add shortcuts for referencing issues and PR

* add example use for :pr: directive
2020-11-08 10:44:24 +01:00
Benjamin Hackl
2839b3f2ce
add basic opengraph metadata to documentation (#684) 2020-11-07 22:57:17 -05:00
Benjamin Hackl
bb404f90b8 let module-level functions render without full module name 2020-10-31 16:11:41 +01:00
Benjamin Hackl
d94a012561 pass html_favicon as string 2020-10-30 20:16:00 +01:00
Naveen M K
7297189358
add favicon changes to conf.py 2020-10-29 14:41:27 +05:30
kolibril13
53f698357c run black 2020-10-24 23:04:24 +02:00
kolibril13
fa185705d6 added copy button 2020-10-24 22:57:47 +02:00
Benjamin Hackl
46c6aa3d5f manim documentation --> Manim documentation 2020-10-20 21:05:39 +02:00
Benjamin Hackl
0b280df22a generate bindings for pangocairoffi and cairoffi manually 2020-09-28 10:04:19 +02:00
Benjamin Hackl
9cdd00ed05 try to generate ffi bindings in RTD 2020-09-28 09:55:05 +02:00
Benjamin Hackl
9c511502cc
Render videos while building documentation (#402)
Implement a sphinx directive to allow for rendering video at the time of generating the documentation
2020-09-11 16:22:06 -04:00
Benjamin Hackl
55eaec8ae8
remove sphinx_rtd_theme again (#408) 2020-09-03 11:57:38 -04:00
Hugues Devimeux
a623a9e4c3
Refactored tests and added new tests tools for videos-tests. (#335)
* 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>
2020-09-01 23:12:39 +02:00
leotrs
44bc307c26 delete unnecessary extension 2020-08-30 19:19:41 -04:00
Leo Torres
662777bb96
Docs (#347)
* 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>
2020-08-28 09:20:21 -04:00
leotrs
46fa54e565 symlinks dont work on windows 2020-08-22 13:18:10 -04:00
leotrs
cda2bbece2 fix sidebars in guzzle theme 2020-08-21 10:44:42 -04:00
kolibril13
4076c6b798
# changed sphinx theme to "guzzle_sphinx_theme" (#328) 2020-08-21 10:12:02 -04:00
Leo Torres
54854ccf23
Documenting the config system (#303)
* 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>
2020-08-16 07:08:26 -04:00
leotrs
7185c77734 use napoleon instead of numpydoc. Also add a new template for class autosummaries 2020-08-14 22:05:03 -04:00