Docs: Line wrap long lines of text for a display (#1140)

* Line wrap long lines of text for a display
* Auto wraps lines of text in the docstrings for the schema docs. Lines
are wrapped to 100 characters.
* Update doc files
* Fix incorrect documentation
* Update src/py-opentimelineio/opentimelineio/console/autogen_serialized_datamodel.py
* Fix lint errors

Signed-off-by: Thomas Wilshaw <thomaswilshaw@gmail.com>

Author: ThomasWilshaw

docs/tutorials/otio-serialized-schema.md

@@ -44,7 +44,8 @@ Adapters convert between OTIO and other formats.
     to OTIO.  You should not need to extend this class to create new adapters
     for OTIO.
 
-    For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an-adapter.html. # noqa
+    For more information: https://opentimelineio.readthedocs.io/en/latest/tutorials/write-an-
+adapter.html. # noqa
     
 ```
 
@@ -63,7 +64,8 @@ parameters:
 
 ```
 
-An object that can be composed within a :class:`~Composition` (such as :class:`~Track` or :class:`.Stack`).
+An object that can be composed within a :class:`~Composition` (such as :class:`~Track` or 
+:class:`.Stack`).
 
 ```
 
@@ -392,13 +394,21 @@ parameters:
 
 ```
 
-An ImageSequenceReference refers to a numbered series of single-frame image files. Each file can be referred to by a URL generated by the :class:`~ImageSequenceReference`.
+An ImageSequenceReference refers to a numbered series of single-frame image files. Each file can be 
+referred to by a URL generated by the :class:`~ImageSequenceReference`.
 
-Image sequences can have URLs with discontinuous frame numbers, for instance if you've only rendered every other frame in a sequence, your frame numbers may be 1, 3, 5, etc. This is configured using the ``frame_step`` attribute. In this case, the 0th image in the sequence is frame 1 and the 1st image in the sequence is frame 3. Because of this there are two numbering concepts in the image sequence, the image number and the frame number.
+Image sequences can have URLs with discontinuous frame numbers, for instance if you've only rendered
+ every other frame in a sequence, your frame numbers may be 1, 3, 5, etc. This is configured using 
+the ``frame_step`` attribute. In this case, the 0th image in the sequence is frame 1 and the 1st 
+image in the sequence is frame 3. Because of this there are two numbering concepts in the image 
+sequence, the image number and the frame number.
 
-Frame numbers are the integer numbers used in the frame file name. Image numbers are the 0-index based numbers of the frames available in the reference. Frame numbers can be discontinuous, image numbers will always be zero to the total count of frames minus 1.
+Frame numbers are the integer numbers used in the frame file name. Image numbers are the 0-index 
+based numbers of the frames available in the reference. Frame numbers can be discontinuous, image 
+numbers will always be zero to the total count of frames minus 1.
 
-An example for 24fps media with a sample provided each frame numbered 1-1000 with a path ``/show/sequence/shot/sample_image_sequence.%04d.exr`` might be
+An example for 24fps media with a sample provided each frame numbered 1-1000 with a path 
+``/show/sequence/shot/sample_image_sequence.%04d.exr`` might be
 
 .. code-block:: json
 
@@ -446,13 +456,15 @@ The same duration sequence but with only every 2nd frame available in the sequen
       "frame_zero_padding": 4,
     }
 
-A list of all the frame URLs in the sequence can be generated, regardless of frame step, with the following list comprehension
+A list of all the frame URLs in the sequence can be generated, regardless of frame step, with the 
+following list comprehension
 
 .. code-block:: python
 
     [ref.target_url_for_image_number(i) for i in range(ref.number_of_images_in_sequence())]
 
-Negative ``start_frame`` is also handled. The above example with a ``start_frame`` of ``-1`` would yield the first three target urls as:
+Negative ``start_frame`` is also handled. The above example with a ``start_frame`` of ``-1`` would 
+yield the first three target urls as:
 
 - ``file:///show/sequence/shot/sample_image_sequence.-0001.exr``
 - ``file:///show/sequence/shot/sample_image_sequence.0000.exr``
@@ -504,9 +516,11 @@ Instead it affects the speed of the media displayed within that item.
 
 ```
 
-A marker indicates a marked range of time on an item in a timeline, usually with a name, color or other metadata.
+A marker indicates a marked range of time on an item in a timeline, usually with a name, color or 
+other metadata.
 
-The marked range may have a zero duration. The marked range is in the owning item's time coordinate system.
+The marked range may have a zero duration. The marked range is in the owning item's time coordinate 
+system.
 
 ```
 
@@ -526,7 +540,8 @@ parameters:
 
 Represents media for which a concrete reference is missing.
 
-Note that a :class:`~MissingReference` may have useful metadata, even if the location of the media is not known.
+Note that a :class:`~MissingReference` may have useful metadata, even if the location of the media 
+is not known.
 
 ```
 
@@ -544,13 +559,16 @@ parameters:
 
 ```
 
-A container which can hold an ordered list of any serializable objects. Note that this is not a :class:`.Composition` nor is it :class:`.Composable`.
+A container which can hold an ordered list of any serializable objects. Note that this is not a 
+:class:`.Composition` nor is it :class:`.Composable`.
 
-This container approximates the concept of a bin - a collection of :class:`.SerializableObject`\s that do
+This container approximates the concept of a bin - a collection of :class:`.SerializableObject`\s 
+that do
 not have any compositional meaning, but can serialize to/from OTIO correctly, with metadata and
 a named collection.
 
-A :class:`~SerializableCollection` is useful for serializing multiple timelines, clips, or media references to a single file.
+A :class:`~SerializableCollection` is useful for serializing multiple timelines, clips, or media 
+references to a single file.
 
 ```
 
@@ -633,7 +651,8 @@ parameters:
 *documentation*:
 
 ```
-Represents a transition between the two adjacent items in a :class:`.Track`. For example, a cross dissolve or wipe.
+Represents a transition between the two adjacent items in a :class:`.Track`. For example, a cross 
+dissolve or wipe.
 ```
 
 parameters:

src/py-opentimelineio/opentimelineio/console/autogen_serialized_datamodel.py

@@ -11,6 +11,7 @@
 import json
 import tempfile
 import sys
+import textwrap
 
 import io
 
@@ -292,11 +293,29 @@ def _write_documentation(model):
         for cl in sorted(modules[module_list], key=lambda cl: str(cl)):
             modname = this_mod
             label = model[cl]["OTIO_SCHEMA"]
+
+            if (cl.__doc__ is not None):
+                docstring = cl.__doc__.split("\n")
+                new_docstring = []
+                for line in docstring:
+                    line = textwrap.wrap(line, width=100,
+                                         expand_tabs=False,
+                                         replace_whitespace=False,
+                                         drop_whitespace=False,
+                                         break_long_words=False)
+                    if (line == []):
+                        line = [""]
+                    for wrapped_line in line:
+                        new_docstring.append(wrapped_line)
+                new_docstring = "\n".join(new_docstring)
+            else:
+                new_docstring = cl.__doc__
+
             md_with_helpstrings.write(
                 CLASS_HEADER_WITH_DOCS.format(
                     classname=label,
                     modpath=modname + "." + cl.__name__,
-                    docstring=cl.__doc__
+                    docstring=new_docstring
                 )
             )
             md_only_fields.write(