From 99c686d7e9091c6d760f3ac92b50f57114cae73f Mon Sep 17 00:00:00 2001 From: Fabrice Quenneville Date: Sat, 21 Nov 2020 01:24:29 -0500 Subject: [PATCH] Working on doc homepage --- README.md | 12 ++---------- docs/_sources/index.rst.txt | 20 +++++++++++++------- docs/genindex.html | 1 - docs/index.html | 16 ++++++---------- docs/objects.inv | Bin 334 -> 318 bytes docs/search.html | 1 - docs/searchindex.js | 2 +- docsource/build/doctrees/environment.pickle | Bin 14718 -> 13655 bytes docsource/build/doctrees/index.doctree | Bin 4972 -> 5722 bytes docsource/build/html/_sources/index.rst.txt | 20 +++++++++++++------- docsource/build/html/genindex.html | 1 - docsource/build/html/index.html | 16 ++++++---------- docsource/build/html/objects.inv | Bin 334 -> 318 bytes docsource/build/html/search.html | 1 - docsource/build/html/searchindex.js | 2 +- docsource/source/index.rst | 20 +++++++++++++------- docsource/source/usage/quickstart.rst | 4 ---- 17 files changed, 55 insertions(+), 61 deletions(-) delete mode 100644 docsource/source/usage/quickstart.rst diff --git a/README.md b/README.md index 417420a..8dda3d7 100644 --- a/README.md +++ b/README.md @@ -4,17 +4,9 @@ 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 ... -## Installation +## Documentation -This package (For now) will only work on GNU/Linux and requires FFMPEG installed. For now it will be distributed on [GitHub](https://github.com/fabquenneville/MediaCurator.git) - -Installation: -```bash -git clone https://github.com/fabquenneville/MediaCurator.git -cd MediaCurator -pip install -r requirements.txt - -``` +The documentation is available [here](https://fabquenneville.github.io/MediaCurator/) ## Usage ./curator.py [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/-files:"/mnt/media/",,"/mnt/media2/"] diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index 733d5da..da395c4 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -2,25 +2,31 @@ sphinx-quickstart on Fri Nov 20 22:46:06 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. - + ======================================== Welcome to MediaCurator's documentation! ======================================== +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 ... + +The source code can be found on `GitHub `_ + .. toctree:: :maxdepth: 2 :caption: Contents: usage/installation - usage/quickstart usage/use_cases usage/errors -Indices and tables -================== +.. Indices and tables +.. ================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +.. * :ref:`genindex` +.. * :ref:`modindex` +.. * :ref:`search` diff --git a/docs/genindex.html b/docs/genindex.html index d22fdb9..3fd2102 100644 --- a/docs/genindex.html +++ b/docs/genindex.html @@ -62,7 +62,6 @@

Contents:

diff --git a/docs/index.html b/docs/index.html index ddd2802..198ffe1 100644 --- a/docs/index.html +++ b/docs/index.html @@ -35,6 +35,12 @@

Welcome to MediaCurator’s documentation!

+

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 …

    • +
+

The source code can be found on GitHub

Contents:

-
  • Quickstart
  • Use cases
  • Errors
    • -
    -

    Indices and tables

    - -
    @@ -81,7 +78,6 @@

    Contents:

    diff --git a/docs/objects.inv b/docs/objects.inv index 6dc8c73005f8b4226aa2666ee8a2206d68ee0e07..06bd2a3c6dc44ff771e08712b431cccd4bec38b8 100644 GIT binary patch delta 202 zcmV;*05$*40=@!}e1Aa-!Y~j;_dP{CKoz%c#f6JPLByrRWM~UXMluQ5o!9Vsp2W6E zZHfgqVe?fNc2Q zTkg=lpD$uv+G{Y5y9UiF(Nyy+z?_0# z@(MCf-May6(Nel=st4*Y)DdV5Ij+>O;xCrE<3%SWw(ta3!3h?|eysqX3E1$>K9(J! EQw#3Couwpn7Wl~2K*H$c^Wzokps%I!m?7%9lK`@FXXd`FA zOGbac-bl3RP=jO12Hl{jQU4ftYKAW(c3h$k7Sia<{e!IJyAwWH!-X z$r6e{?KuYT(Nn%_u19L#)d?_;SX$ey_>JZ6>qmPfwKxZ(j;-qXyFu?oeEq&BI1ucW UB>3^>w-wPXf#|Nq0|M2!BIXumHUIzs diff --git a/docs/search.html b/docs/search.html index cb71970..2984384 100644 --- a/docs/search.html +++ b/docs/search.html @@ -81,7 +81,6 @@

    Contents:

    diff --git a/docs/searchindex.js b/docs/searchindex.js index 77e6e58..d50283d 100644 --- a/docs/searchindex.js +++ b/docs/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/quickstart","usage/use_cases"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/quickstart.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,Use:0,audio:1,bash:[],big:1,big_valu:1,chapter:1,clone:2,code:[],com:2,content:0,damag:1,decod:1,distribut:2,download:2,error:0,fabquennevil:2,ffmpeg:0,found:1,frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:0,instal:0,linux:2,mediacur:2,miss:1,modul:0,mpeg:1,now:2,onli:2,packag:2,page:0,pip:2,quickstart:0,referenc:1,requir:2,search:0,sei:1,sourc:[],thi:2,too:1,track:1,txt:2,type:1,work:2},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,document:0,error:1,ffmpeg:2,from:2,github:2,indic:0,instal:2,mediacur:0,quickstart:3,tabl:0,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/use_cases"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,The:0,Use:0,all:0,audio:1,av1:0,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,command:0,content:0,damag:1,databas:0,decod:1,distribut:2,download:2,error:0,extent:0,fabquennevil:2,ffmpeg:0,filter:0,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:0,manag:0,media:0,mediacur:2,miss:1,modern:0,modul:[],more:0,mpeg:1,now:2,onli:2,packag:2,page:[],pip:2,python:0,quickstart:[],recod:0,referenc:1,requir:2,search:[],sei:1,sourc:0,thi:2,too:1,tool:0,track:1,txt:2,type:1,video:0,without:0,work:2,x265:0},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Use cases"],titleterms:{"case":3,Use:3,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:[],tabl:[],welcom:0}}) \ No newline at end of file diff --git a/docsource/build/doctrees/environment.pickle b/docsource/build/doctrees/environment.pickle index bf8fdbaae5986550d926c7f4c4ea42c07c2152cb..bc0d8d9b7b3245c4d89d10bfd33216d33bd61336 100644 GIT binary patch delta 3967 zcmb_fYiv|S6z*=jt$oop(udpErrTl*(uaK_plxt*Yqg+7{6U({-Q8(-C;MpcL+OvY zhyrQ6^x<4Xf?$e?e?Vgl@rU}WF$N6@i7}=z#P|ydNJLG15n?km5&v4Zi{l@eDcB(2~zSUnQ3s>MhgcTEk%9Jj|(i2hd?zBbu7; zV$NvCwAZy+trZhGn;2B{rvwp2WDPHobB+F>NMRR2v>A&7Zmhw`xQ0(r)xwt~3%Sqk$Z2*oSl_n@VQm!Soa_gO<$+A4zzJ`Wvy0fgek68&D^cFAx=l7&!6kb}`k zviamG?!o5_7(95pX|S7`Qf+cj4j~P!QKmCk+e*TX)nv+9XCWle*j~m#ub4m&GXEFY zh@uvSqLE2vKw?Z!Qxi*6Fj^@eJV@#ncYuMZd2-ZeQkf^qP4*s|Cxd#H)51_tl088g zg(0zPWr*Bv>L^Q5B-@=e`;y049ur%@yf5$>>KV)4-|)3=_DEG{m79jB76}nwASya9^L=yd z^9^q9x+`%j|+k_e;3%>q@UWcF|La zzo&w2ly6f4S!K@RA9!<>H$U>`C%RE$w8mNU?~MP18IF1-8&n1!|7HB9LtN%W-NTVL zQ8(VEeiT5FBZ~;7DP8pavTj(+0i$Sjk*m#HNo~uH;(x#ge20p=#NTqX%$f(kO8ONrRnmm7j`Q}vrV#@F}l1{vzEtEH9Kh=tWF&`7kG z%l7Jsg~YmdAE3D(hpO8|3>ZX`T0RjBA;}|0JtFcd!H}QTs&v@`ET?LVj7Xz*H!(+? zJ!91)utLorn+bcPAtRS($;lqKwKR{c_P8v=q`tQaABQRwJJ_%|k zwBwrh1UwccB#6F%h6xP9>tjvG;xV?!u^%45nt@ns_@j~Wfft{crLIvCa39z3TePPp ddK5oy1m;fD-n;QRAdB1>c-s0w9_iSz?|%@|ou>c* delta 4743 zcmcIoYiv|S6z=Z!&8rJYp}T3sKgi`MDdY;36FTr%-wtM_HLK1%Ac7# zkMo@~-<+8<=bjRt0+k+N!GO*-rT9i zBTvhUASrZD-JFl#sk`LP7!sQ|ocXQkanG$i<3xFXY41%ZhHi{q?bK#)d{q_)B7!W+ z#!y+Si}bilN^oNH+@{V`sx~z$rbVzZ8HvNRScu+O81xx7?9XGUzF((He2ueItumgB zB-E%F)yXhml4q#oYbRUf;492w5N5o-8r#k($ent5q>9KC|3RL|%ISiFnzLE3zf^JPQJIPU) zLOy~*4GZLLr~!q3>%S*M-iHQY9AlMAjzdj8ghCAy1-}bxt=?vCm!6~9KESnq#z0N& zobf*%DPmoI+02aDsd$NzJz-xp`L?SuwBJX;Y=ezgsm4% zXHH2Nu2!m~A~s>>K2ySKA|WaRiMWhjWOs~e(=*2CqK3KCbG#)$yBb1o9_T_SI+24UikCxB|FSByqw;8HWMgk$&g*&NFQX;eOpZh!SmU zxzFpoq#kW~u%;O}Aj_}_VX>UP)$-izRY(jwPc|Du%X%}_oPhZ_9wyf(FrVC-Xuu7E z`4-IYftfwYXgngy^+GaQuLxmuyPT65%r}FZ)W=LRk0>6QoV{%B)MhP#+Z*v)0Kdh+ zH?ECYAkKlhoj}WSi8Vy(Op%RFkrnwwv?}!Yfw&?L8GgWt6z$jA%Dj>}M}`~9eJDpZ zzoBu{(7#|`CgZpy%~r%u`9x0o|7`zi=BpFO0rCk<;0qpc(wwu!^J!DS+Ysw^Z0Yk( z!Td~FTe^3$A{M#3og(=|ltC^FQFoWzwKj6?QO$m+$d@L;C!8zDCD^6VZOyZNEJj!- z=D1VrPV{~-SrLog_naaH>1EOA?$TRf(2J3r$ClG3m*<`4j^k3z$K_e4*qyliezGDK zm#3W~1-WGJi=w#<6cYz3vkyXitgK;y`hrPjMQP5xMSkYQ|H7+_yt>S*D-gKnyLymZ z{+MyWV)+G9S_}+BGp>@G(BKd*22mhz+hgK-5VM}T{~{>TWA`rTMlQ7J#>1_C)25-c zIB0~ArNu1B;H5d>AJ5B@Vqo&~QeO;2+>UV#8l2mOoLf7CF!tXF6oT`r%-fC%!Mf$_ z<=0z`xdw4x2ZQ5@+guEcebJUfbrl1Vv15!U&U^_JJ|1?6KcHdv>pMX_#)QcgJBDS( z?c7_X2s7x0)&&g`p!T`ho1@Rg(h8{X7KaKipgs>BZe2SUr}aZF;&`}z)w-Y^JNFxj z$^rJQwOaVTwOY%wEm{@YUi%P$YUSH^4TVz)D}^{p&v37Y!+a zY&jBFcoKzqQ7>K77V^IYTS>OU1TqF+W?q91w}re6U0cW@dZ4W%^D6s(jg?(s#};xJ zzDLRHP(nWYCacu2R+bcoSms5tYK=^u>138@6_9F6nCoZrGXTKk3@UtJK!p@Sg%tMd zs;ap&gwH+#dUoqt#ZW4$@(j<^Q#vFlF$QT&nidn}0dc3w)@&&oWx7V0s!^tClqnij zO(=JImko$~QCji@Xf=mD66AnrJ6B}&%SsgcwJB*SHJD0c!isv0d0Kfw2#X13iB>r% zCi#yUa+Z4ATU_Vpy7rYdKfwCPk68SK#RWRjzSMgjJ_E!yL{GNYuCcXo>SZYQ=_7i0 zA7oLoC`b`V+^#|=Tt-fSnvOZ+b^T5|J08COEMj31>mJd`MQmNlwh+yLgt2Sbx^9dC Qcl7g)F1M?UR<79k4_c^-Gynhq diff --git a/docsource/build/doctrees/index.doctree b/docsource/build/doctrees/index.doctree index 8265f79f06fa5d37c7f1b2e50d8d1f8217c45924..dda39e4fe5cafc9948de481983835cb7ff502112 100644 GIT binary patch delta 2006 zcmcIl%}*0S6sMN00-`BV3_)~Ml=6`__=Ps&2P8_OB8e!`Na(aX^et(3>+US#!4wZB z9`?3Nj3?xv(Rd<|cr+&d1;%(VoH%pw>P6q|M@z-3#L&Zb`)20-KHi(xwPRm{K2*UQ^$hl(wHO1hB=8zvSGOfr=>p&UE9Dgf1>X2E+AP*D{1SN`Z&E#ZK$#JF| z9`Or-A28+%xv(+o>g@C1PxoD&ef2|kJ*dc z+e#B_HwL|lwGw_}Kd3z`eS**M#eP>?Y+4aXKKk7k#f=~AA?d`P_ra0!U}&&kNCQ#? z7uJNMG8}<+akw-O{UohuPeW;lH1%)z1h?>aOXYhbfW8Z$&T2qy6+qE0VoyZ&c0?_F zOQI*qRFm4Mz10qyncl#4AzSeUz4JC}inn!@{=E_|lbK^WnZe+&*;@AFvFIrd1~{27g#! dhWJyS605_o{M3XN@zdSc4U6!0sk3P?^b_fIxMKhS delta 1290 zcmb7^-)j>=5XTd*mzbuprjpdE#VYofHMSr^DN@utRsu!Dr)Vz8nz@)$%&erBy8v3eN`T;VN8%>*7kd-j}vv7?LmoqcAqt4RN?A zK8Mc@&*E$X{Gc>EDLV_N#~;Xhatu@mKroGyNpY&@vRcK+ig>A>vTo={sJ>}BhPAbS-Q2v zVcpJZ&`-4uV2-0$8}D+q=Zb0NB@dc|Rz5-b7z|>>ar{oCC7oPg^=o22G*}FvKfjQZ zkm4a{TGn(!!V4Zm%eq@(k}I?Y597#cm6D#*ExF>j7qzM(pE&Cfa)DXWQ!Axe{SEjq zrhA6zjzvjb@uwbTT%7y(=bIt0tcIi46V$l0Zn>-iWHM_{3#m- RNTCHV;Y34ut3Q_X{{m!k%iRC~ diff --git a/docsource/build/html/_sources/index.rst.txt b/docsource/build/html/_sources/index.rst.txt index 733d5da..da395c4 100644 --- a/docsource/build/html/_sources/index.rst.txt +++ b/docsource/build/html/_sources/index.rst.txt @@ -2,25 +2,31 @@ sphinx-quickstart on Fri Nov 20 22:46:06 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. - + ======================================== Welcome to MediaCurator's documentation! ======================================== +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 ... + +The source code can be found on `GitHub `_ + .. toctree:: :maxdepth: 2 :caption: Contents: usage/installation - usage/quickstart usage/use_cases usage/errors -Indices and tables -================== +.. Indices and tables +.. ================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +.. * :ref:`genindex` +.. * :ref:`modindex` +.. * :ref:`search` diff --git a/docsource/build/html/genindex.html b/docsource/build/html/genindex.html index d22fdb9..3fd2102 100644 --- a/docsource/build/html/genindex.html +++ b/docsource/build/html/genindex.html @@ -62,7 +62,6 @@

    Contents:

    diff --git a/docsource/build/html/index.html b/docsource/build/html/index.html index ddd2802..198ffe1 100644 --- a/docsource/build/html/index.html +++ b/docsource/build/html/index.html @@ -35,6 +35,12 @@

    Welcome to MediaCurator’s documentation!

    +

    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 …

      • +
    +

    The source code can be found on GitHub

    Contents:

    -
  • Quickstart
  • Use cases
  • Errors
    • -
    -

    Indices and tables

    - -
    @@ -81,7 +78,6 @@

    Contents:

    diff --git a/docsource/build/html/objects.inv b/docsource/build/html/objects.inv index 6dc8c73005f8b4226aa2666ee8a2206d68ee0e07..06bd2a3c6dc44ff771e08712b431cccd4bec38b8 100644 GIT binary patch delta 202 zcmV;*05$*40=@!}e1Aa-!Y~j;_dP{CKoz%c#f6JPLByrRWM~UXMluQ5o!9Vsp2W6E zZHfgqVe?fNc2Q zTkg=lpD$uv+G{Y5y9UiF(Nyy+z?_0# z@(MCf-May6(Nel=st4*Y)DdV5Ij+>O;xCrE<3%SWw(ta3!3h?|eysqX3E1$>K9(J! EQw#3Couwpn7Wl~2K*H$c^Wzokps%I!m?7%9lK`@FXXd`FA zOGbac-bl3RP=jO12Hl{jQU4ftYKAW(c3h$k7Sia<{e!IJyAwWH!-X z$r6e{?KuYT(Nn%_u19L#)d?_;SX$ey_>JZ6>qmPfwKxZ(j;-qXyFu?oeEq&BI1ucW UB>3^>w-wPXf#|Nq0|M2!BIXumHUIzs diff --git a/docsource/build/html/search.html b/docsource/build/html/search.html index cb71970..2984384 100644 --- a/docsource/build/html/search.html +++ b/docsource/build/html/search.html @@ -81,7 +81,6 @@

    Contents:

    diff --git a/docsource/build/html/searchindex.js b/docsource/build/html/searchindex.js index 77e6e58..d50283d 100644 --- a/docsource/build/html/searchindex.js +++ b/docsource/build/html/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/quickstart","usage/use_cases"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/quickstart.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,Use:0,audio:1,bash:[],big:1,big_valu:1,chapter:1,clone:2,code:[],com:2,content:0,damag:1,decod:1,distribut:2,download:2,error:0,fabquennevil:2,ffmpeg:0,found:1,frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:0,instal:0,linux:2,mediacur:2,miss:1,modul:0,mpeg:1,now:2,onli:2,packag:2,page:0,pip:2,quickstart:0,referenc:1,requir:2,search:0,sei:1,sourc:[],thi:2,too:1,track:1,txt:2,type:1,work:2},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,document:0,error:1,ffmpeg:2,from:2,github:2,indic:0,instal:2,mediacur:0,quickstart:3,tabl:0,welcom:0}}) \ No newline at end of file +Search.setIndex({docnames:["index","usage/errors","usage/installation","usage/use_cases"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["index.rst","usage/errors.rst","usage/installation.rst","usage/use_cases.rst"],objects:{},objnames:{},objtypes:{},terms:{"case":0,"while":1,For:2,The:0,Use:0,all:0,audio:1,av1:0,base:0,bash:[],batch:0,big:1,big_valu:1,can:0,chapter:1,clone:2,code:0,codec:0,com:2,command:0,content:0,damag:1,databas:0,decod:1,distribut:2,download:2,error:0,extent:0,fabquennevil:2,ffmpeg:0,filter:0,found:[0,1],frame:1,from:0,git:2,github:0,gnu:2,header:1,http:2,index:[],instal:0,line:0,linux:2,list:0,manag:0,media:0,mediacur:2,miss:1,modern:0,modul:[],more:0,mpeg:1,now:2,onli:2,packag:2,page:[],pip:2,python:0,quickstart:[],recod:0,referenc:1,requir:2,search:[],sei:1,sourc:0,thi:2,too:1,tool:0,track:1,txt:2,type:1,video:0,without:0,work:2,x265:0},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Use cases"],titleterms:{"case":3,Use:3,document:0,error:1,ffmpeg:2,from:2,github:2,indic:[],instal:2,mediacur:0,quickstart:[],tabl:[],welcom:0}}) \ No newline at end of file diff --git a/docsource/source/index.rst b/docsource/source/index.rst index 733d5da..da395c4 100644 --- a/docsource/source/index.rst +++ b/docsource/source/index.rst @@ -2,25 +2,31 @@ sphinx-quickstart on Fri Nov 20 22:46:06 2020. You can adapt this file completely to your liking, but it should at least contain the root `toctree` directive. - + ======================================== Welcome to MediaCurator's documentation! ======================================== +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 ... + +The source code can be found on `GitHub `_ + .. toctree:: :maxdepth: 2 :caption: Contents: usage/installation - usage/quickstart usage/use_cases usage/errors -Indices and tables -================== +.. Indices and tables +.. ================== -* :ref:`genindex` -* :ref:`modindex` -* :ref:`search` +.. * :ref:`genindex` +.. * :ref:`modindex` +.. * :ref:`search` diff --git a/docsource/source/usage/quickstart.rst b/docsource/source/usage/quickstart.rst deleted file mode 100644 index f41ce4b..0000000 --- a/docsource/source/usage/quickstart.rst +++ /dev/null @@ -1,4 +0,0 @@ - -========== -Quickstart -========== \ No newline at end of file