Commit graph

31 commits

Author SHA1 Message Date
Darylgolden
a8c20635e7
note that process is not ready (#2101) 2021-09-29 09:25:14 +02: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
Benjamin Hackl
89bcec8f2f
Reworked installation instructions (#1949)
* move plugins

* plugins in main sidebar

* restructure installation guide

* fix some removed references

* more sphinx fixes

* restructured developer installation, more cleanup

* rename some files

* rewrote MacOS installation instructions

* rewrote the windows installation guide

* cleaned up linux installation instructions

* added a lot of colons

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* improve first paragraph of installation.rst

* move docker and jupyter to separate files

* Copyediting

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* change wording regarding colab env

* copyediting, second pass

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* first mention recommended ffmpeg installation for windows

* move admonition above table of contents

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-08-28 12:50:29 +00:00
Hugues Devimeux
2ab04aee10
Updated docs for the test refactor (Tests PR 2/3) (#1835)
* Added docs

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

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

* Fixed typo

* Suggestions

* Apply suggestions from code review

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>

* Update docs/source/contributing/testing.rst

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>

* Added imports

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

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

* Added explanaiton for __modue_test__

* Apply suggestions from code review

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>

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

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

* add needed line

* Update docs/source/contributing/testing.rst

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>

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>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-08-01 07:41:21 +00:00
Raghav Prabhakar
8c3c7b8e6f
Add codespell in contribution docs. (#1815) 2021-07-19 17:13:55 -04:00
Benjamin Hackl
17a3c637e8
Improve sidebar structure of reference manual (#1778)
* move modules in reference manual around to have nicer sidebar structure

* use short names in page titles and sidebar

* fix broken reference

* remove some autogenerated files that shouldn't be tracked

* include module list in reference.html

Co-authored-by: Darylgolden <darylgolden@gmail.com>
2021-07-19 12:19:21 -04:00
Jason Villanueva
e9aa7d3696
Renamed instances of master to main (#1720) 2021-06-24 08:57:30 -07:00
Jason Villanueva
6f13981f23
Removed Container ABC (#1652)
* Removed Container ABC and unnecessary imports

* Remove test for container

* Remove kwargs from Scene/Mobject

* Updated NumberLine and related test

* Fix graphscene test by removing unused arg

* Fix other TypeError issues in other test cases

* Fix doctest

* Fixed usages of ParametricFunction

* Removed stale references to container

* Removed unused parameters passed to Paragraph

* Added style parameter to prevent errors from MarkupText/Text

* Remove unnecessary style parameter

* Update tests/test_number_line.py

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>

* Remove numberline parameters

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

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

* Update scene.py

* Remove unused font_size param

* Removed leftover font_size

* Apply suggestions from code review

Co-authored-by: friedkeenan <friedkeenan@protonmail.com>

* Readded tests for Mobjects/Scene without Container

* Applied suggestion for PointCloudMobject

* Pass path_string_config only if OpenGL

* Readds args to Paragraph, removes **config from VGroup.__init__ calls

* Fixed test_scene test case and removed added param

* Apply second pass suggestions

* Fix incorrect merge in Mobject

Co-authored-by: Laith Bahodi <70682032+hydrobeam@users.noreply.github.com>
Co-authored-by: friedkeenan <friedkeenan@protonmail.com>
2021-06-24 08:13:24 -07:00
Nikhil Garuda
005adf48e5
Made the extension of the pull-requests picture lowercase. (#1610) 2021-06-01 09:09:43 -05:00
Nikhil Garuda
e36618a04d
Fixed the typo for Admonitions (#1551) 2021-05-21 15:35:13 +02:00
Nikhil Garuda
6a3be2797d
Restructuring of Contribution Section (#1550)
* Added Docstrings

* Added Examples

* Added references

* Added Typings

* Added Adominations

* Made some more changes for docs to work

* Fixed spelling mistake
2021-05-21 14:13:35 +02:00
Skaft
60a775714e
Adding spell checker as a pre-commit hook (#1544)
* adding codespell precommit hook

* adding codespell config file

* fixing typos

* tweaking variable names to please codespell
2021-05-21 15:43:31 +05:30
Skaft
40bfc27dd2
Fixing broken links and other minor doc things (#1541)
* fix typos

* lowercasing note admonition

* fixing broken links

* fixing title underlines being too short
2021-05-19 05:56:32 -05:00
Nikhil Sharma
488a177df1
Updated Discord links in the docs to point towards a standardized redirect (#1499)
* Update README.md

* updated discord links
2021-05-13 02:02:35 +02:00
Nikhil Garuda
1746073b8c
Added entry for typestring parser check tool (#1402)
* Added typestring parser checker

* Updated some errors

* Update

* Checking if installation wokrs

* Trying again

* Updates

* Another Update

* Update pyproject.toml

* Update documentation.rst

* Update requirements.txt

* Update

* syntax highlighting should work?

* Update

* Reverted back

* Will this work?

* Update

* Still trying

* Update

* Update again

* Fixed the indentation issues

* Update

* updated code block

* Update again

* Update

* Update again with blackendocs

* Update documentation.rst

* Added skip option to doctests

* Added the link

* Update link
2021-05-06 22:26:10 -07: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
Skaft
bbe113e7d3
Fixing broken doc links (#1457)
* fix broken links

* fix typo
2021-05-03 21:13:51 +05:30
Nikhil Garuda
fccce24a9b
Added Guide to Contribute Examples from GitHub Wiki to Documentation (#1387)
* Changed prepare_animation example

* Update animation.py

* Changed prepare_animation example

* Update animation.py

* Update animation.py

* Reverted

* Add Guide to Contribute Examples

* Update

* Rewrote some of the guide

Updated issues with docs rendering improperly.
Fixed some grammar.
Perhaps broke some things

* Update docs/source/contributing/documentation.rst

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

* Update documentation.rst

* Update

* Update docs/source/contributing/documentation.rst

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

* Trigger Build

* Updated

* Build pls work

* Update

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* Apply suggestions from code review

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

* updated note tab

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-30 21:59:56 +02:00
Benjamin Hackl
7f17ea6d24
Fixed all current docbuild warnings (#1424)
* fix all current docbuild warnings

* Rerun rtd

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-29 19:04:08 -07:00
kolibril13
cf8ae0811e
Add admonitions tutorial to docs (#1389)
* more docs

* more docs

* refining

* comma fix

* refine further

* typo

* typo

* refine

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* Update docs/source/contributing/documentation.rst

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>

* applied suggestions

Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-28 21:03:11 -07:00
Nikhil Garuda
80a1bfcd2f
Add flake8 and isort in docs (#1376)
* Grammatical error correction of docs

* Update contributing.rst

* Update development.rst

* Update development.rst

* Update development.rst

* Update for_dev.rst

* Update docs/source/installation/for_dev.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Update plugins.rst

* Update reporting_bugs.rst

* Update a_deeper_look.rst

* Update configuration.rst

* Update quickstart.rst

* Update building_blocks.rst

* Update testing.rst

* Update testing.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update quickstart.rst

* Update quickstart.rst

* Update development.rst

* Update development.rst

* Update versions.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update building_blocks.rst

* Change of complier and output format in
 "InCodeTexTemplate" to the defaults

* Reverted back

* Change of Complier and Output format

The Complier and Output format of class InCodeTexTemplate has been changed to the defaults (latex and .dvi)

* Update customtex.py

* Update building_blocks.rst

* Update building_blocks.rst

* Update a_deeper_look.rst

* Updated Code Style to include isort and flake8

* Update

* Update

* Delete test.py

* Update development.rst

* Update development.rst

* Update development.rst

* Update development.rst

* Update docs/source/contributing/development.rst

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>

* Update development.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: kilacoda <65204531+kilacoda@users.noreply.github.com>
Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-04-21 17:50:51 -07:00
Nikhil Garuda
7c8c1cb1d9
Grammatical error corrections in documentation (#1360)
* Grammatical error correction of docs

* Update contributing.rst

* Update development.rst

* Update development.rst

* Update development.rst

* Update for_dev.rst

* Update docs/source/installation/for_dev.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Update plugins.rst

* Update reporting_bugs.rst

* Update a_deeper_look.rst

* Update configuration.rst

* Update quickstart.rst

* Update building_blocks.rst

* Update testing.rst

* Update testing.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update quickstart.rst

* Update quickstart.rst

* Update development.rst

* Update development.rst

* Update versions.rst

* Update versions.rst

* Update a_deeper_look.rst

* Update building_blocks.rst

* Change of complier and output format in
 "InCodeTexTemplate" to the defaults

* Reverted back

* Change of Complier and Output format

The Complier and Output format of class InCodeTexTemplate has been changed to the defaults (latex and .dvi)

* Update customtex.py

* Update building_blocks.rst

* Update building_blocks.rst

* Update a_deeper_look.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: kilacoda <65204531+kilacoda@users.noreply.github.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-19 15:44:32 -07:00
Nikhil Garuda
f8beaa4ba2
Changed the format (#1358) 2021-04-18 10:20:47 +02:00
kolibril13
642b7683b2
Added documentation guidelines for type hints (#1338)
* added guidlines for typehints

* added lines

* Apply suggestions from code review

Co-authored-by: Darylgolden <darylgolden@gmail.com>

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* added ``None`` typehint

* added Optional

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* Update documentation.rst

* blacken-docs

* Update docs/source/contributing/documentation.rst

* Update documentation.rst

Co-authored-by: Darylgolden <darylgolden@gmail.com>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-16 21:01:21 -07:00
Naveen M K
7417fbc599
Blacken docs (#1323)
this hook will check formats in docs code blocks and format it using black
2021-04-13 11:57:27 +05:30
Aron
053e40060d
Remove Carriage Return (#1281)
Co-authored-by: Aron Fischer <cobordism@github, co-bordism@gitlab>
Co-authored-by: Naveen M K <naveen@syrusdark.website>
2021-04-07 15:22:50 -07:00
Jason Villanueva
5b2d5c3f8b
Added sphinx requirements to pyproject.toml (#1279)
* Added Sphinx dependencies to pyproject.toml

* Updated documentation

* Updates poetry.lock

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-04-07 21:58:38 +02: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
Darylgolden
9c96d16db1
Copyedited the document on testing in our documentation (#1217)
* Copyediting testing.rst

* More copyediting

* Clarifications on how to generate control test data

* More copyediting

* removed one whitespace

* More fixes

* Minor fix

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
Co-authored-by: Jason Villanueva <a@jsonvillanueva.com>
2021-04-01 22:27:12 -07:00
Jason Villanueva
e384ce93f2
Added testing/documentation from GitHub Wiki to Sphinx Docs (#1137)
* Added precommit for black, updated contributing documentation

Updated contributing.rst and related files

Fixed some grammar, added pre-commit section

* picked pre-commit version, removed redundant language_version

* Fix section headings

* Added GitHub testing/doc Wiki pages to docs

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Update docs/source/contributing.rst

* Update docs/source/contributing.rst

Co-authored-by: Naveen M K <naveen@syrusdark.website>

* Fixed some relative links

* Fixed flake8 issue

* Apply suggestions from code review

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

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-03-31 02:23:38 -07:00