Commit graph

19 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
Benjamin Hackl
8bebfb907b
Removed suggestion issue template, added FAQ answer regarding proposing new features (#2828)
* removed suggestion template

* added FAQ answer regarding proposing new features

* added link to project board in contributing.rst

Co-authored-by: Tristan Schulz <mrdiverlp@gmail.com>
2022-06-18 13:45:40 +02:00
Darylgolden
859c1793f6
Added guide on profiling and improving performance (#2517)
* Guide on performance

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

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

* Update docs/source/contributing/performance.rst

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

* Try to get code block to render

* Update docs/source/contributing/performance.rst

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

* try fix

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-02-03 07:12:02 +08:00
Darylgolden
3add3c21a9
Add note about contributions during refactor period (#2500)
* Note about contributions

* md link

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

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

* Fix typo

* improve phrasing

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2022-01-30 14:23:28 +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
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
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 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
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
Jason Villanueva
54ead3b61f
Added pre-commit to run black and flake8, updated contributing documentation accordingly (#1130)
* 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

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

* Update docs/source/contributing.rst

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

* Add in missing flake stuff to lock

* Added flake8 to pre-commit

* added newlines at the end of .flake8 and .pre-commit-config.yaml

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

* Apply suggestions from code review

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

* Reorder mentioning of tests after writing code

* Removed extra -

Co-authored-by: Naveen M K <naveen@syrusdark.website>
Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-03-30 14:33:59 +05:30
Darylgolden
08de9249d0
Note about using latest version (#1190) 2021-03-29 22:25:05 +02:00
Bogdan Stăncescu
2f4ade6285
Docs: Added code example to Mobject.get_critical_point(), fixed some broken formatting, added some links to installation guides (#1077)
* +doc Mobject.get_critical_point()

* Minor fix for minor doc improvement

* Minor indentation fix

* A few additional, minor doc improvements

* Update docs/source/installation/for_dev.rst

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

* fix broken link to contributing guide

Co-authored-by: Benjamin Hackl <devel@benjamin-hackl.at>
2021-03-23 00:52:57 +01:00
Jason Villanueva
2276cb059f
Added code of conduct (#935)
* Added code of conduct

* Added CoC to sphinx/README.md

* Shortened verbosity in  Enforcement Procedures

* Made conduct.rst a symlink

* Update CODE_OF_CONDUCT.md

* Update CODE_OF_CONDUCT.md

* Tweaked header section levels

Co-authored-by: kolibril13 <44469195+kolibril13@users.noreply.github.com>
2021-01-18 19:14:57 +05:30
kolibril13
5f1cfa3c9d
Added flowchart for Docs overview (#828)
* added flowchart

* updated flowchart

* added second flowchart
2020-12-05 21:26:55 +05:30
Benjamin Hackl
d7a68d5dc5 fix formatting of a list 2020-09-23 10:13:59 +02:00
Benjamin Hackl
a3175a1be5 remove capitalization 2020-09-21 02:37:43 +02:00
Benjamin Hackl
530e2c6990 add reference to manim_directive 2020-09-20 22:15:01 +02:00
Benjamin Hackl
0fcaeb94d9 reformat contributing.rst as restructuredText, try to simplify 2020-09-20 21:51:10 +02:00
Benjamin Hackl
fd9bfacf9f contributing.md -> contributing.rst 2020-09-20 19:49:27 +02:00
Renamed from docs/source/contributing.md (Browse further)