Fix #525 Resolve documentation build errors and some most

Zulko · Apr 5, 2017 · a4a8c9e · a4a8c9e
1 parent 332ca21
commit a4a8c9e
Show file tree

Hide file tree

Showing 31 changed files with 167 additions and 341 deletions.
diff --git a/docs/FAQ.rst b/docs/FAQ.rst
@@ -25,7 +25,7 @@ I can't seem to read any video with MoviePy
 """"""""""""""""""""""""""""""""""""""""""""""
 
 Known reason: you have a deprecated version of FFMPEG, install a recent version from the
-website, not from your OS's repositories ! (see :ref:`installation`).
+website, not from your OS's repositories ! (see :ref:`install`).
 
 Previewing videos make them slower than they are
 """""""""""""""""""""""""""""""""""""""""""""""""

diff --git a/docs/conf.py b/docs/conf.py
@@ -46,7 +46,7 @@
 
 # General information about the project.
 project = u'MoviePy'
-copyright = u'2014, Zulko'
+copyright = u'2017, Zulko'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -55,7 +55,7 @@
 # The short X.Y version.
 version = '0.2'
 # The full version, including alpha/beta/rc tags.
-release = '0.2'
+release = '0.2.3.1'
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
@@ -263,7 +263,7 @@
 epub_title = u'MoviePy'
 epub_author = u'Zulko'
 epub_publisher = u'Zulko'
-epub_copyright = u'2013, Zulko'
+epub_copyright = u'2017, Zulko'
 
 # The language of the text. It defaults to the language option
 # or en if the language is not set.

diff --git a/docs/examples/examples.rst b/docs/examples/examples.rst
@@ -17,6 +17,10 @@ Here are a few example scripts to get you started. Most are quite old now and wi
    masked_credits
    painting_effect
    compo_from_image
+   logo
+   headblur
+   quick_recipes
+   several_characters
    the_end
 
 

diff --git a/docs/examples/logo.rst b/docs/examples/logo.rst
@@ -5,6 +5,4 @@ MoviePy logo with a moving shadow
 
         <div style="position: relative; padding-bottom: 56.25%; padding-top: 30px; margin-bottom:30px; height: 0; overflow: hidden; margin-left: 5%;"><iframe type="text/html" src="https://youtube.com/embed/TG86KzL18NA&hl=en_US&fs=1&rel=0" frameborder="0" style="position: absolute; top: 0; bottom: 10; width: 90%; height: 100%;"></iframe></div>
 
-Here the logo is a picture, while the shadow is actually a black rectangle taking the whole screen, overlaid over the logo, but with a moving mask composed of a bi-gradient, such that only one (moving) part of the rectangle is visible. See :ref:`gradients` for the code of the function `biGradient`: ::
-
-
+Here the logo is a picture, while the shadow is actually a black rectangle taking the whole screen, overlaid over the logo, but with a moving mask composed of a bi-gradient, such that only one (moving) part of the rectangle is visible.
diff --git a/docs/examples/masked_credits.rst b/docs/examples/masked_credits.rst
@@ -7,7 +7,7 @@ Partially Hidden credits
 
         <div style="position: relative; padding-bottom: 56.25%; padding-top: 30px; margin-bottom:30px; height: 0; overflow: hidden; margin-left: 5%;"><iframe type="text/html" src="https://youtube.com/embed/NsTgBah6Ebk&hl=en_US&fs=1&rel=0" frameborder="0" style="position: absolute; top: 0; bottom: 10; width: 90%; height: 100%;"></iframe></div>
 
-First, see in :ref:`autocredits` how to make credits automatically with MoviePy. Before seeing the code for this video, here is a tutorial video that explains the different steps (also made with MoviePy):
+Before seeing the code for this video, here is a tutorial video that explains the different steps (also made with MoviePy):
 
 .. raw:: html
 

diff --git a/docs/examples/severalCharacters.rst → docs/examples/several_characters.rst b/docs/examples/severalCharacters.rst → docs/examples/several_characters.rst
@@ -1,4 +1,4 @@
-.. charDuplication:
+.. char_duplication:
 
 Character duplication in a video
 -----------------------------------

diff --git a/docs/examples/star_worms.rst b/docs/examples/star_worms.rst
@@ -5,8 +5,6 @@ This is an approximate effect (the perspective would require some more complex t
 
 Warning: clip with sound.
 
-.. raw:: html
-
 Let us also have a look at this tutorial which shows the different steps:
 
 .. raw:: html

diff --git a/docs/gallery.rst b/docs/gallery.rst
@@ -46,7 +46,7 @@ Animations edited with MoviePy
 GIFs made from videos
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This  `tutorial
+This  `gifs tutorial
 <https://zulko.github.io/blog/2014/01/23/making-animated-gifs-from-video-files-with-python/>`_ gives you the basics to make gifs from video files (cutting, croping, adding text...). The last example shows how to remove a (still) background to keep only the animated part of a video.
 
 
@@ -58,7 +58,7 @@ This  `tutorial
 Vector Animations
 ~~~~~~~~~~~~~~~~~~~
 
-This `tutorial <https://zulko.github.io/blog/2014/09/20/vector-animations-with-python/>`_ shows how to combine MoviePy with Gizeh to create animations:
+This `vector animations tutorial <https://zulko.github.io/blog/2014/09/20/vector-animations-with-python/>`_ shows how to combine MoviePy with Gizeh to create animations:
 
 .. raw:: html
 
@@ -72,7 +72,7 @@ It is also possible to combine MoviePy with other graphic librairies like matplo
 3D animations
 ~~~~~~~~~~~~~~~~~~~
 
-This `tutorial <https://zulko.github.io/blog/2014/11/13/things-you-can-do-with-python-and-pov-ray/>`_ shows how to combine MoviePy with Vapory, a library to render 3D scenes using the free ray-tracer POV-Ray
+This `3d animation tutorial <https://zulko.github.io/blog/2014/11/13/things-you-can-do-with-python-and-pov-ray/>`_ shows how to combine MoviePy with Vapory, a library to render 3D scenes using the free ray-tracer POV-Ray
 
 .. raw:: html
 
@@ -114,7 +114,7 @@ Or use `this script <https://gist.github.com/Zulko/b910c8b22e8e1c01fae6>`_ to ma
 Data animations
 ----------------
 
-This `tutorial <https://zulko.github.io/blog/2014/11/13/things-you-can-do-with-python-and-pov-ray/>`_ shows how to use MoviePy to animate the different Python vizualization libraries: Mayavi, Vispy, Scikit-image, Matplotlib, etc.
+This `data animation tutorial <https://zulko.github.io/blog/2014/11/13/things-you-can-do-with-python-and-pov-ray/>`_ shows how to use MoviePy to animate the different Python vizualization libraries: Mayavi, Vispy, Scikit-image, Matplotlib, etc.
 
 
 Scientific or technological projects
@@ -124,7 +124,7 @@ Scientific or technological projects
 Piano rolls transcription to sheet music
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-This `blog post <https://zulko.github.io/blog/2014/02/12/transcribing-piano-rolls/>`_ explains how to transform a video of a piano roll performance into playable sheet music. MoviePy is used for the frame-by-frame analysis of the piano roll video. The last video is also edited with MoviePy:
+This `transcribing piano rolls blog post <https://zulko.github.io/blog/2014/02/12/transcribing-piano-rolls/>`_ explains how to transform a video of a piano roll performance into playable sheet music. MoviePy is used for the frame-by-frame analysis of the piano roll video. The last video is also edited with MoviePy:
 
 .. raw:: html
 
@@ -170,7 +170,7 @@ Here are `Videogrep's introductory blog post
 
 If you liked it, also have a look at these Videogrep-inspired projects:
 
-This `blog post <https://zulko.github.io/blog/2014/06/21/some-more-videogreping-with-python/>`_ attempts to cut a video precisely at the beginning and end of sentences or words: ::
+This `Videogrep blog post <https://zulko.github.io/blog/2014/06/21/some-more-videogreping-with-python/>`_ attempts to cut a video precisely at the beginning and end of sentences or words: ::
 
     words = ["Americans", "must", "develop", "open ", "source",
               " software", "for the", " rest ", "of the world",

diff --git a/docs/getting_started/audio.rst b/docs/getting_started/audio.rst
diff --git a/docs/getting_started/audioclips.rst b/docs/getting_started/audioclips.rst
@@ -1,6 +1,4 @@
-.. _audio:
-
-
+.. _audioclips:
 
 Audio in MoviePy
 -----------------
@@ -9,7 +7,6 @@ This section shows how to use MoviePy to create and edit audio clips.
 
 Note that when you cut, mix or concatenate video clips in MoviePy the audio is automatically handled and you need to worry about it. This section is of interest if you just want to edit audiofiles or you want custom audio clips for your videos.
 
-
 What audioclips are made of
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
@@ -19,31 +16,25 @@ AudioClips are very similar to video clips in moviepy: they have a length, can b
 Creating a new audio clip
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-Audio clips can be created from an audio file or from the soundtrack of a video file
-::
+Audio clips can be created from an audio file or from the soundtrack of a video file ::
+
     from moviepy.editor import *
     audioclip = AudioFileClip("some_audiofile.mp3")
     audioclip = AudioFileClip("some_video.avi")
 
-Alternatively you can get the audio track of an already created video clip:
+for more, see :py:class:`~moviepy.audio.io.AudioFileClip.AudioFileClip`.
+
+Alternatively you can get the audio track of an already created video clip ::
 
     videoclip = VideoFileClip("some_video.avi")
     audioclip = videoclip.audio
 
-You can also
-
 Compositing audio clips
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-
 Exporting and previewing audio clips
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-You can export
+You can also export assign an audio clip as the soundtrack of a video clip with ::
 
-You can
-
-You can also export assign an audio clip as the soundtrack of a video clip with::
-    
     videoclip2 = videoclip.set_audio(my_audioclip)
-