Commit graph

65 commits

Author SHA1 Message Date
Benjamin Hackl
04503adb70
Fix Sphinx exceptions when trying to build documentation via latex / as pdf (#4370)
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2025-08-06 08:43:50 -04:00
Benjamin Hackl
95fba7da10
Change project management tool from poetry to uv (#4138)
* rewrite pyproject.toml to support uv; version upgrades of several dev dependencies

* codespellrc: poetry.lock -> uv.lock

* rewrite workflows, first attempt

* change name of pre-commit-hook

* dev-dependencies -> dependency-groups.dev

* lint + format

* Update .github/workflows/ci.yml

Co-authored-by: Aarush Deshpande <110117391+JasonGrace2282@users.noreply.github.com>

* convert development.rst to myst markdown

* fix (most) docbuild warnings from theme upgrade

* development instructions: switch to uv, plus minor updates

* update entrypoint config in plugin docs + tests

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

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

---------

Co-authored-by: Aarush Deshpande <110117391+JasonGrace2282@users.noreply.github.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2025-02-02 17:16:46 +01:00
Aarush Deshpande
953888e68e
Rewrite installation instructions (#3930)
Follow-up to #3501

This commit combines all the installation documentation onto one page, and switches to recommending the usage
of `uv` for installing Manim.
2024-12-06 18:50:18 -05:00
Aarush Deshpande
3a4ab4cd25
Rename parameters and variables conflicting with builtin functions (#3884)
* Config for flake8-builtins

* Manual changes for flake8-builtins
2024-07-25 20:06:18 +02:00
adeshpande
f463423abe
Use ruff instead of flake8-simplify (#3873)
* pyproject

* Autofixes from pre-commit

* use get over get(x, None)

Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>

---------

Co-authored-by: Victorien <65306057+Viicos@users.noreply.github.com>
2024-07-22 16:22:11 +00:00
adeshpande
679b89a43f
fix(copyright): automate copyright updating for docs (#3708) 2024-04-19 23:42:17 +02:00
Francisco Manríquez Novoa
02391d71ac
Added support for Manim type aliases in Sphinx docs + Added new TypeAliases (#3484)
* Updated manim.typing and included TypeAliases in docs.source.conf

* Added Vector2 and reorganized manim_type_aliases

* Fixed __all__ exports for __all__ of manim

* Update manim/cli/render/global_options.py

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

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

* Draft of new typing docs and new autotyping directive

* Changed vertical bars to Unions

* Updated poetry.lock

* Created custom file parser for manim.typing

* Got reST parser going

* Updated autotyping and parsing

* Update parsing

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

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

* Added code_block toggle

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

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

* Added typings to directives

* Renamed Tuple to tuple in manim.typings

* Added missing docs for type aliases

* Fixed exponent typo in ManimInt

* Hyperlinks to types work - removed Module Attributes section

* Removed Unused Import

Remove ``import re``

* Added freeglut-devel to workflows for Linux

Hopefully (?) fix the GLU import error

* Fix package name

* Add support for Type Aliases section in every module - Renaming of Vector types

* Add/fix docs for directive, parser and others

* Fixed alias typo in module_parsing

* Fix decode/import bugs, fix minor details in docs

* Added missing docs for utils.docbuild and utils.testing

* Sort alphabetically entries in utilities_misc.rst

* Address review comments, add notes about Vector and hyperlinks inside definition blocks

---------

Co-authored-by: MrDiver <mrdiverlp@gmail.com>
Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Co-authored-by: JasonGrace2282 <aarush.deshpande@gmail.com>
2023-12-29 19:04:31 +01:00
Naveen M K
adfef5e7a5
Add option to run examples directly with binder (#3427)
* Add option to run examples directly with binder

The minified JS is from
https://github.com/naveen521kk/manim-binder

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

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

* slight style changes

* update the js file to fix on chrome

Signed-off-by: Naveen M K <naveen521kk@gmail.com>

* show the run button as an cursor

* make the video to be 100% of the width

* Update manim/utils/docbuild/manim_directive.py

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

* Add a "Make interactive" button instead of "Run" button

Clicking on the "Make interactive" button show the code-editor and "run" button

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

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

* update margin for run interactive button

---------

Signed-off-by: Naveen M K <naveen521kk@gmail.com>
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>
2023-11-10 21:52:43 +01:00
Tristan Schulz
82e55b5da2
Adding :class: ManimColor to manim and converting all types (#3020)
* first draft of color class + starting library conversion

* [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

* changed everything to Manim color todo: figure out circular dependency in utils

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

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

* first working draft of new color version

* resolving conflicts

* resolving conflicts

* resolving conflicts

* resolving conflicts

* resolving conflicts

* changed default internal value of ManimColor to np.ndarray[float]

* starting to fix tests

* fixed more tests and changed precision of manim color

* removed premature color conversion

* fixed some more tests

* final test changes

* fix doctests

* fix for 3.8

* fixing ManimColor string representation

* removing some unneccesary conversions

* moved community constants to manim_colors.py and added more color standards

* broke some too long lines

* added fallback: check whether passed object has get_hex method

* actually fix _internal_from_string

* added hsv support

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

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

* remove dependency on colour

* fixed DARK_EARTH being assigned twice

* fixed double assignment

* remove more duplicated colour names

* raise NotImplementedError for ManimColor.gradient

* removed unused import

* remove superfluous ManimColor import

* fix circular import, remove dependency of space_ops on config

* one more Color -> ParseableManimColor

* removed one *-import

* somewhat unrelated fixed type hint

* -1 *-import

* fixed change of logic in CoordinateSystem.get_graph_label

* removed debug print; fixed type hint in mobject.py

* some fixes and improvements to text_mobject.py

* update three_dimensions

* fixes for rendered documentation of utils.color.*

* substantial improvements to documentation, including new Sphinx directive

Co-authored-by: MrDiver <mrdiverlp@gmail.com>

* Rewrite of the sphinx directive to use docutils nodes and 2 column design

* I just had to do it

* Improve the color table

* minor cleanup

* fixed ColorOverview example

* documentation improvements

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

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

* Update manim/mobject/mobject.py

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>

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

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

* fix flake8 errors

* Removed test in test_text_mobject

* Improved Documentation of core.py and added private members in sphinx so that internal methods can be documented

* Change color types of labeled.py

* removed some unused imports

* turned docstring into comment

* _colors  -> _all_manim_colors; move to manim_color module

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

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

* fixed typing

* rewrite import

---------

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>
Co-authored-by: Naveen M K <naveen521kk@gmail.com>
2023-08-08 14:47:00 +02: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