Resolve documentation build errors #526

mbeacom · 2017-04-05T06:47:51Z

The goal of this PR is to resolve build ERRORS during make html.

Add missing dependencies to documentation requirement file.
Fix missing toctree entries and link errors.

Note: Once this is merged, we should re-deploy the documentation pages.

coveralls · 2017-04-05T06:53:46Z

Coverage remained the same at 50.16% when pulling a4a8c9e on mbeacom:dev-docs into 332ca21 on Zulko:master.

keikoro

@mbeacom I realise a number of the things I marked weren't your changes at all but were already part of the original docs/previous version of them, though it might make sense to fix them right now, in one go. (Otherwise I'll have to go in and fix them (again) at a later point. ^^)

keikoro · 2017-04-05T07:17:25Z

docs/getting_started/audioclips.rst

 Compositing audio clips
 ~~~~~~~~~~~~~~~~~~~~~~~~

-
 Exporting and previewing audio clips
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~



You can also export assign an audio clip as the soundtrack of a video clip with ::

I'm guessing this should just be "assign"?

keikoro · 2017-04-05T07:25:01Z

docs/getting_started/videoclips.rst

@@ -53,36 +54,95 @@ VideoClip
   :width: 128 px
   :align: center

-Note: three next sections are in construction
+Note that clips make with a `make_frame` do not have an explicit frame rate, so you must provide a frame rate (``fps``, frames er second) for ``write_gif`` and ``write_videofile``, and more generally for any methods that requires iterating through the frames.



*per second

*methods that require
(also, I think it's iterate over)

keikoro · 2017-04-05T07:26:45Z

docs/getting_started/videoclips.rst

+    myclip = VideoFileClip("some_video.avi")
+    myclip = VideoFileClip("some_animation.gif")
+
+Note that these clips will have an ``fps`` (frame per second) attribute, which will be transmitted if you do small modifications of the clip, and will be used by default in ``write_videofile``, ``write_gif``, etc. For instance: ::


frames per second, make small modifications to

keikoro · 2017-04-05T07:27:13Z

docs/getting_started/videoclips.rst

+
+    clip = ImageSequenceClip(images_list, fps=25)
+
+where ``images_list`` can be either a list of image names (that will be *played*) in that order, a folder name (at which case all the image files in the folder will be played in alphanumerical order), or a list of frames (Numpy arrays), obtained for instance from other clips.


in which case

keikoro · 2017-04-05T07:27:37Z

docs/getting_started/videoclips.rst

+
+where ``images_list`` can be either a list of image names (that will be *played*) in that order, a folder name (at which case all the image files in the folder will be played in alphanumerical order), or a list of frames (Numpy arrays), obtained for instance from other clips.
+
+When you provide a folder name or list of file names, you can choose ``load_images=True`` to specify that all images should be loaded into the RAM. This is only interesting if you have a small number of images that will be each used more than once (e.g. if the images form a looping animation).


that will each be used

keikoro · 2017-04-05T07:32:33Z

docs/opencv_instructions.rst

@@ -7,29 +7,29 @@ OpenCV is very optional, its installation is not always simple and I found it to
 The installation seems easy for Windows. On linux, here is what I found on the Internet:

 - Remove any other version of OpenCV if you installed it through a package manager.
- Unzip the source code of `OpenCV 2.4.6`_ in some folder. open a terminal in this folder.
+- Unzip the source code of `OpenCV 2.4.6` in some folder. open a terminal in this folder.


keikoro · 2017-04-05T07:33:29Z

docs/ref/code_origanization.rst

@@ -5,7 +5,7 @@ Organization of MoviePy's code

 This reviews the folders and files in moviepy's code. It's very easy:

-At the root of the project you have everything required for the packaging and installation of moviepy (README, setup.py, LICENCE) etc. Then you the ``docs/`` folder with the source code of the documentation (see :ref:`updating_docs`), a folder for some :ref:`examples`, and the main folder ``moviepy/`` for the source code of the library itself.
+At the root of the project you have everything required for the packaging and installation of moviepy (README, setup.py, LICENCE) etc. Then you the ``docs/`` folder with the source code of the documentation, a folder for some :ref:`examples`, and the main folder ``moviepy/`` for the source code of the library itself.


MoviePy
also, there is a word missing, but no idea what it is: "Then you the docs"

keikoro · 2017-04-05T07:34:06Z

docs/ref/ref.rst

@@ -20,4 +20,4 @@ If you want to hack into the code or locate a particular function, read :ref:`co
   audiotools
   ffmpeg
   decorators
-
+   code_origanization


organization? (spelling?)

keikoro · 2017-04-05T07:37:52Z

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`).


repositories! (no space)

keikoro · 2017-04-05T07:38:15Z

docs/gallery.rst

@@ -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.


visualization

mbeacom · 2017-04-05T07:44:11Z

@kerstin I didn't mean for this PR to be copy changes. The only copy that was changed was to resolve errors or consolidate.

The goal of this PR is to resolve build ERRORS during make html.

mbeacom · 2017-04-05T14:56:14Z

@Earney @Zulko Anyone else have opinions on this?
I can make the copy changes here or split them off into a separate PR.

I'm not at all opposed to the changes requested here, but I wasn't looking to modify actual copy until after the documentation was at a buildable state (i.e. the follow-up PR to this being merged).

It's a matter of preference, but I prefer to limit PRs to a specific goal and try not to trail off on random line changes beyond what's necessary for the resolution and syntax-based formatting changes.

Additionally, the copy changes that did make their way into this PR were due to completing of the video/audio clips documentation separation. The copy should have come directly from one of previously existing files.

Just a note: I did make the mistake of updating the copyright in this PR versus waiting for the follow-up which was a consistency mistake on my part. Sorry about that!

Thank you all!

coveralls · 2017-04-05T15:19:46Z

Coverage remained the same at 50.16% when pulling f30a439 on mbeacom:dev-docs into 6da89ec on Zulko:master.

ghost · 2017-04-05T15:35:48Z

I believe it is best to limit PRs to a specific goal as much as possible, but a few minor random line changes would be okay from time to time, but shouldn't be a day to day practice. (I know I have been guilty of this numerous times!)

mbeacom · 2017-04-05T15:40:26Z

@Earney Do you think I should make the requested corrections in this PR or offload them to another PR following merging this one?

ghost · 2017-04-05T15:44:23Z

@mbeacom I don't care. I haven't spent much time in the docs, so I leave that up to you guys on what you think is best for this PR.

mbeacom added documentation Related to documentation in official project docs or individual docstrings. enhancement Positive change that does not change the API, i.e. improved performance, using less memory etc. labels Apr 5, 2017

mbeacom mentioned this pull request Apr 5, 2017

Documentation build failures #525

Closed

keikoro reviewed Apr 5, 2017

View reviewed changes

Fix Zulko#525 Resolve documentation build errors and some most

f30a439

mbeacom force-pushed the dev-docs branch from a4a8c9e to f30a439 Compare April 5, 2017 15:08

mbeacom merged commit 5eda6c0 into Zulko:master Apr 5, 2017

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Resolve documentation build errors #526

Resolve documentation build errors #526

mbeacom commented Apr 5, 2017 •

edited by tburrows13

Loading

coveralls commented Apr 5, 2017 •

edited

Loading

keikoro left a comment

keikoro Apr 5, 2017

keikoro Apr 5, 2017

keikoro Apr 5, 2017

keikoro Apr 5, 2017

keikoro Apr 5, 2017

keikoro Apr 5, 2017

keikoro Apr 5, 2017

keikoro Apr 5, 2017

keikoro Apr 5, 2017

keikoro Apr 5, 2017

keikoro Apr 5, 2017

mbeacom commented Apr 5, 2017 •

edited

Loading

mbeacom commented Apr 5, 2017 •

edited

Loading

coveralls commented Apr 5, 2017 •

edited

Loading

ghost commented Apr 5, 2017

mbeacom commented Apr 5, 2017 •

edited

Loading

ghost commented Apr 5, 2017


		clip = ImageSequenceClip(images_list, fps=25)

		where ``images_list`` can be either a list of image names (that will be played) in that order, a folder name (at which case all the image files in the folder will be played in alphanumerical order), or a list of frames (Numpy arrays), obtained for instance from other clips.


		where ``images_list`` can be either a list of image names (that will be played) in that order, a folder name (at which case all the image files in the folder will be played in alphanumerical order), or a list of frames (Numpy arrays), obtained for instance from other clips.

		When you provide a folder name or list of file names, you can choose ``load_images=True`` to specify that all images should be loaded into the RAM. This is only interesting if you have a small number of images that will be each used more than once (e.g. if the images form a looping animation).

Resolve documentation build errors #526

Resolve documentation build errors #526

Conversation

mbeacom commented Apr 5, 2017 • edited by tburrows13 Loading

coveralls commented Apr 5, 2017 • edited Loading

keikoro left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

mbeacom commented Apr 5, 2017 • edited Loading

mbeacom commented Apr 5, 2017 • edited Loading

coveralls commented Apr 5, 2017 • edited Loading

ghost commented Apr 5, 2017

mbeacom commented Apr 5, 2017 • edited Loading

ghost commented Apr 5, 2017

mbeacom commented Apr 5, 2017 •

edited by tburrows13

Loading

coveralls commented Apr 5, 2017 •

edited

Loading

mbeacom commented Apr 5, 2017 •

edited

Loading

mbeacom commented Apr 5, 2017 •

edited

Loading

coveralls commented Apr 5, 2017 •

edited

Loading

mbeacom commented Apr 5, 2017 •

edited

Loading