Merge branch 'master' of github.com:3b1b/manim into diffyq

.travis.yml

@@ -4,6 +4,10 @@ dist: xenial    # required for Python 3.7 (travis-ci/travis-ci#9069)
 python: "3.7"
 cache: pip
 
+addons:
+  apt:
+    packages:
+      - python3-sphinx
 install:
   - pip install --upgrade pip
   - pip install -r requirements.txt
@@ -16,6 +20,8 @@ before_script:
 script:
   - python setup.py test
   - python setup.py bdist_wheel
+after_success:
+  - test $TRAVIS_BRANCH = "master" && test $TRAVIS_PULL_REQUEST = "false" && travis/build_docs.sh
 deploy:
   provider: pypi
   user: eulertour

README.md

@@ -1,8 +1,10 @@
 <img src="logo/cropped.png"/>
 
-[![Documentation Status](https://readthedocs.org/projects/manim/badge/?version=latest)](https://manim.readthedocs.io/en/latest/?badge=latest)
 [![Build Status](https://travis-ci.org/3b1b/manim.svg?branch=master)](https://travis-ci.org/3b1b/manim)
+[![Documentation](https://img.shields.io/badge/docs-EulerTour-blue.svg)](https://www.eulertour.com/learn/manim/)
 [![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)
+[![Manim Subreddit](https://img.shields.io/reddit/subreddit-subscribers/manim.svg?color=ff4301&label=reddit)](https://www.reddit.com/r/manim/)
+[![Manim Subreddit](https://img.shields.io/discord/581738731934056449.svg?label=discord)](https://discord.gg/mMRrZQW)
 
 Manim is an animation engine for explanatory math videos. It's used to create precise animations programmatically, as seen in the videos at [3Blue1Brown](https://www.3blue1brown.com/).
 

docs/source/installation/linux.rst

@@ -1,4 +1,41 @@
 Linux
 =====
 
-A stub for linux installation
+Ubuntu
+------
+
+Install system libraries::
+
+    # apt install sox ffmpeg libcairo2 libcairo2-dev
+
+Install Latex distribution::
+
+    # apt install texlive-full
+
+Install manim via pypi::
+
+    # pip3 install manimlib
+
+OR Install manim via the git repository with venv::
+
+    $ git clone https://github.com/3b1b/manim
+    $ cd manim
+    $ python3 -m venv ./
+    $ source bin/activate
+    $ pip3 install -r requirement.txt
+
+To use manim in virtual environment you need to activate the environment with
+the ``activate`` binary by doing ``source bin/activate``, to exit use the ``deactivate`` command.
+
+.. note:: The git repository is updated first before the one on pypi. The git repository also
+          includes project files used to produce 3b1b videos. Some of the old projects might not
+          work as due to api changes.
+
+
+.. note:: The required latex packages are dictated by
+          ``manimlib/tex_template.tex`` which ``texlive-full`` will satisfy. The download size
+          can be quite large. If you wish to install only the packages required to use
+          manim, substitude ``texlive-full`` with::
+
+            texlive texlive-latex-extra texlive-fonts-extra
+            texlive-latex-recommended texlive-science texlive-fonts-extra tipa

requirements.txt

@@ -6,5 +6,5 @@ progressbar==2.5
 scipy==1.1.0
 tqdm==4.24.0
 opencv-python==3.4.2.17
-pycairo==1.17.1
+pycairo>=1.17.1
 pydub==0.23.0

travis/build_docs.sh

@@ -0,0 +1,10 @@
+#!/bin/bash
+
+pip install sphinx_rtd_theme
+make --directory docs/ html
+openssl aes-256-cbc -K $encrypted_1b28e850a424_key \
+                    -iv $encrypted_1b28e850a424_iv \
+                    -in travis/crypt.enc \
+                    -out travis/crypt -d
+tar xf travis/crypt
+travis/deploy_docs.sh