Working on doc homepage

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)
+The documentation is available [here](https://fabquenneville.github.io/MediaCurator/)
-
-Installation:
-```bash
-git clone https://github.com/fabquenneville/MediaCurator.git
-cd MediaCurator
-pip install -r requirements.txt 
-
-```
 
 ## 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/"]

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 <https://github.com/fabquenneville/MediaCurator>`_
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    usage/installation
-   usage/quickstart
    usage/use_cases
    usage/errors
 
 
 
-Indices and tables
+.. Indices and tables
-==================
+.. ==================
 
-* :ref:`genindex`
+.. * :ref:`genindex`
-* :ref:`modindex`
+.. * :ref:`modindex`
-* :ref:`search`
+.. * :ref:`search`

docs/genindex.html

@@ -62,7 +62,6 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docs/index.html

@@ -35,6 +35,12 @@
             
   <div class="section" id="welcome-to-mediacurator-s-documentation">
 <h1>Welcome to MediaCurator’s documentation!<a class="headerlink" href="#welcome-to-mediacurator-s-documentation" title="Permalink to this headline">¶</a></h1>
+<p>MediaCurator is a Python command line tool to manage a media database.</p>
+<ul class="simple">
+<li><p>List all the video’s and their codecs with or without filters</p></li>
+<li><p>Batch recode videos to more modern codecs (x265 / AV1) based on filters: extentions, codecs …</p></li>
+</ul>
+<p>The source code can be found on <a class="reference external" href="https://github.com/fabquenneville/MediaCurator">GitHub</a></p>
 <div class="toctree-wrapper compound">
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
@@ -43,19 +49,10 @@
 <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-from-github">Install from GitHub</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>
 </div>
-<div class="section" id="indices-and-tables">
-<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
-<ul class="simple">
-<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
-<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
-<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
-</ul>
-</div>
 </div>
 
 
@@ -81,7 +78,6 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docs/search.html

@@ -81,7 +81,6 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

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}})
+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}})

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 <https://github.com/fabquenneville/MediaCurator>`_
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    usage/installation
-   usage/quickstart
    usage/use_cases
    usage/errors
 
 
 
-Indices and tables
+.. Indices and tables
-==================
+.. ==================
 
-* :ref:`genindex`
+.. * :ref:`genindex`
-* :ref:`modindex`
+.. * :ref:`modindex`
-* :ref:`search`
+.. * :ref:`search`

docsource/build/html/genindex.html

@@ -62,7 +62,6 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docsource/build/html/index.html

@@ -35,6 +35,12 @@
             
   <div class="section" id="welcome-to-mediacurator-s-documentation">
 <h1>Welcome to MediaCurator’s documentation!<a class="headerlink" href="#welcome-to-mediacurator-s-documentation" title="Permalink to this headline">¶</a></h1>
+<p>MediaCurator is a Python command line tool to manage a media database.</p>
+<ul class="simple">
+<li><p>List all the video’s and their codecs with or without filters</p></li>
+<li><p>Batch recode videos to more modern codecs (x265 / AV1) based on filters: extentions, codecs …</p></li>
+</ul>
+<p>The source code can be found on <a class="reference external" href="https://github.com/fabquenneville/MediaCurator">GitHub</a></p>
 <div class="toctree-wrapper compound">
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
@@ -43,19 +49,10 @@
 <li class="toctree-l2"><a class="reference internal" href="usage/installation.html#install-from-github">Install from GitHub</a></li>
 </ul>
 </li>
-<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>
 </div>
-<div class="section" id="indices-and-tables">
-<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
-<ul class="simple">
-<li><p><a class="reference internal" href="genindex.html"><span class="std std-ref">Index</span></a></p></li>
-<li><p><a class="reference internal" href="py-modindex.html"><span class="std std-ref">Module Index</span></a></p></li>
-<li><p><a class="reference internal" href="search.html"><span class="std std-ref">Search Page</span></a></p></li>
-</ul>
-</div>
 </div>
 
 
@@ -81,7 +78,6 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

docsource/build/html/search.html

@@ -81,7 +81,6 @@
 <p class="caption"><span class="caption-text">Contents:</span></p>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="usage/installation.html">Installation</a></li>
-<li class="toctree-l1"><a class="reference internal" href="usage/quickstart.html">Quickstart</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/use_cases.html">Use cases</a></li>
 <li class="toctree-l1"><a class="reference internal" href="usage/errors.html">Errors</a></li>
 </ul>

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}})
+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}})

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 <https://github.com/fabquenneville/MediaCurator>`_
+
 .. toctree::
    :maxdepth: 2
    :caption: Contents:
 
    usage/installation
-   usage/quickstart
    usage/use_cases
    usage/errors
 
 
 
-Indices and tables
+.. Indices and tables
-==================
+.. ==================
 
-* :ref:`genindex`
+.. * :ref:`genindex`
-* :ref:`modindex`
+.. * :ref:`modindex`
-* :ref:`search`
+.. * :ref:`search`

docsource/source/usage/quickstart.rst

@@ -1,4 +0,0 @@
-
-==========
-Quickstart
-==========