documentation

This commit is contained in:
2025-12-16 19:04:02 -08:00
parent 43dd48dea7
commit 09ccdb8c8d

View File

@@ -1,3 +1,4 @@
import pycmx
.. pycmx documentation master file, created by .. pycmx documentation master file, created by
sphinx-quickstart on Wed Dec 26 21: 51: 43 2018. sphinx-quickstart on Wed Dec 26 21: 51: 43 2018.
You can adapt this file completely to your liking, but it should at least You can adapt this file completely to your liking, but it should at least
@@ -6,11 +7,11 @@
pycmx - A CMX EDL Parser in Python pycmx - A CMX EDL Parser in Python
== == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == == ==
The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
Features Features
--------- ---------
The `pycmx` package parses a CMX 3600 EDL and its most most common variations.
* The major variations of the CMX 3600: the standard, "File32", "File128" and * The major variations of the CMX 3600: the standard, "File32", "File128" and
long Adobe Premiere event numbers are automatically detected and properly long Adobe Premiere event numbers are automatically detected and properly
read. Event number field and source name field sizes are determined read. Event number field and source name field sizes are determined
@@ -45,7 +46,6 @@ function:
.. code-block: : python .. code-block: : python
import pycmx
with open("tests/edls/TEST.edl") as f: with open("tests/edls/TEST.edl") as f:
edl = pycmx.parse_cmx3600(f) edl = pycmx.parse_cmx3600(f)