From 44a222fe8b2aec25e489a2d65f2fe8a3e9b221db Mon Sep 17 00:00:00 2001 From: Fabrice Quenneville Date: Sat, 21 Nov 2020 18:57:30 -0500 Subject: [PATCH] Working on documentation --- README.md | 5 +- docs/_sources/usage/manual.rst.txt | 60 ++++++++++++++++++ docs/_sources/usage/quickstart.rst.txt | 4 ++ docs/_sources/usage/use_cases.rst.txt | 1 - docs/index.html | 11 +++- docs/searchindex.js | 2 +- docs/usage/manual.html | 56 +++++++++++++++- docs/usage/quickstart.html | 11 +++- docs/usage/use_cases.html | 6 +- docsource/build/doctrees/environment.pickle | Bin 17398 -> 20111 bytes docsource/build/doctrees/usage/manual.doctree | Bin 4333 -> 9664 bytes .../build/doctrees/usage/quickstart.doctree | Bin 4353 -> 5165 bytes .../build/doctrees/usage/use_cases.doctree | Bin 2280 -> 2280 bytes .../build/html/_sources/usage/manual.rst.txt | 60 ++++++++++++++++++ .../html/_sources/usage/quickstart.rst.txt | 4 ++ .../html/_sources/usage/use_cases.rst.txt | 1 - docsource/build/html/index.html | 11 +++- docsource/build/html/searchindex.js | 2 +- docsource/build/html/usage/manual.html | 56 +++++++++++++++- docsource/build/html/usage/quickstart.html | 11 +++- docsource/build/html/usage/use_cases.html | 6 +- .../_build/html/.doctrees/environment.pickle | Bin 17187 -> 20125 bytes .../html/.doctrees/usage/manual.doctree | Bin 4333 -> 9664 bytes .../html/.doctrees/usage/quickstart.doctree | Bin 4353 -> 5165 bytes .../html/.doctrees/usage/use_cases.doctree | Bin 2280 -> 2280 bytes .../html/.doctrees/usage/warnings.doctree | Bin 2940 -> 5991 bytes .../_build/html/_images/Screenshot-delete.png | Bin 0 -> 162558 bytes .../_build/html/_sources/usage/manual.rst.txt | 60 ++++++++++++++++++ .../html/_sources/usage/quickstart.rst.txt | 4 ++ .../html/_sources/usage/use_cases.rst.txt | 1 - .../html/_sources/usage/warnings.rst.txt | 38 +++++++++++ .../_build/html/_static/Screenshot-delete.png | Bin 0 -> 162558 bytes docsource/source/_build/html/index.html | 11 +++- docsource/source/_build/html/searchindex.js | 2 +- .../source/_build/html/usage/manual.html | 55 +++++++++++++++- .../source/_build/html/usage/quickstart.html | 5 +- .../source/_build/html/usage/use_cases.html | 6 +- .../source/_build/html/usage/warnings.html | 23 +++++++ docsource/source/usage/manual.rst | 60 ++++++++++++++++++ docsource/source/usage/quickstart.rst | 4 ++ docsource/source/usage/use_cases.rst | 1 - 41 files changed, 549 insertions(+), 28 deletions(-) create mode 100644 docsource/source/_build/html/_images/Screenshot-delete.png create mode 100644 docsource/source/_build/html/_static/Screenshot-delete.png diff --git a/README.md b/README.md index ba46c11..2693c6c 100644 --- a/README.md +++ b/README.md @@ -1,8 +1,9 @@ # MediaCurator MediaCurator is a Python command line tool to manage a media database. -* List all the video's and their codecs with or without filters -* Batch recode videos to more modern codecs (x265 / AV1) based on filters: extentions, codecs ... +* List all the video’s and their information with or without filters +* Batch find and repair/convert videos with encoding errors +* Batch recode videos to more modern codecs (x265 / AV1) based on filters: extentions, codecs, resolutions … ## Documentation diff --git a/docs/_sources/usage/manual.rst.txt b/docs/_sources/usage/manual.rst.txt index cb3979f..796951f 100644 --- a/docs/_sources/usage/manual.rst.txt +++ b/docs/_sources/usage/manual.rst.txt @@ -2,6 +2,14 @@ Manual ====== +Name +---- + + MediaCurator + +Synopsis +-------- + .. code-block:: bash ./curator.py [list,convert] [-del] @@ -11,6 +19,48 @@ Manual [-print:list,formated,verbose] [-dir/-files:"/mnt/media/",,"/mnt/media2/"] +Description +----------- + +Options +------- + +list + +convert + +-del: + +-in: + [any,avi,mkv,wmv,mpg,mp4,m4v,flv,vid] +-filters: + [fferror,old,lowres,hd,720p,1080p,uhd,mpeg,mpeg4,x264,wmv3,wmv] +-out: + [mkv/mp4,x265/av1] +-print: + [list,formated,verbose] +-dir: + ["/mnt/media/",,"/mnt/media2/"] +-files: + ["/mnt/media/video.avi",,"/mnt/media2/video2.mp4"] + +Examples +-------- + + +See Also +-------- + +Author +------ + +Fabrice Quenneville + + + + + + **for multiple files or filenames use double comma separated values ",,"** default options are: @@ -29,3 +79,13 @@ Examples: ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/" ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ + + + +Synopsis + + + +Description + + diff --git a/docs/_sources/usage/quickstart.rst.txt b/docs/_sources/usage/quickstart.rst.txt index 120587c..178a468 100644 --- a/docs/_sources/usage/quickstart.rst.txt +++ b/docs/_sources/usage/quickstart.rst.txt @@ -26,6 +26,10 @@ Examples: .. code-block:: bash + # List all videos with old codec in formated format ./curator.py list -filters:old -print:formated -dir:/mnt/media/ >> ../medlist.txt + # Convert all videos with the codec mpeg4 in a mp4 using the av1 video codec and the delete the originals ./curator.py convert -del -filters:mpeg4 -out:av1,mp4 -dir:"/mnt/media/Movies/" ./curator.py convert -del -in:avi,mpg -print:formated,verbose -dir:/mnt/media/ + +More examples in :doc:`use_cases` \ No newline at end of file diff --git a/docs/_sources/usage/use_cases.rst.txt b/docs/_sources/usage/use_cases.rst.txt index 21de4bb..d69455b 100644 --- a/docs/_sources/usage/use_cases.rst.txt +++ b/docs/_sources/usage/use_cases.rst.txt @@ -1,4 +1,3 @@ - ========= Use cases ========= \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index b0bbf4f..39ab4e3 100644 --- a/docs/index.html +++ b/docs/index.html @@ -52,7 +52,16 @@
  • Quickstart
  • -
  • Manual
  • +
  • Manual +
  • Use cases
  • Errors
  • Quickstart
  • -
  • Manual
  • +
  • Manual +
  • Use cases
  • Errors