diff --git a/docs/.nojekyll b/docs/.nojekyll old mode 100755 new mode 100644 diff --git a/docs/_sources/index.rst.txt b/docs/_sources/index.rst.txt index aa327c5..733d5da 100644 --- a/docs/_sources/index.rst.txt +++ b/docs/_sources/index.rst.txt @@ -2,7 +2,8 @@ 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! ======================================== diff --git a/docs/_sources/usage/errors.rst.txt b/docs/_sources/usage/errors.rst.txt index d4621e1..c27ea6c 100644 --- a/docs/_sources/usage/errors.rst.txt +++ b/docs/_sources/usage/errors.rst.txt @@ -1,3 +1,5 @@ + +====== Errors ====== diff --git a/docs/_sources/usage/installation.rst.txt b/docs/_sources/usage/installation.rst.txt index e50cd8d..fcdbd7d 100644 --- a/docs/_sources/usage/installation.rst.txt +++ b/docs/_sources/usage/installation.rst.txt @@ -1,2 +1,20 @@ +============ Installation -============ \ No newline at end of file +============ + +This package (For now) will only work on GNU/Linux and requires FFMPEG installed. For now it will be distributed on `GitHub `_ + +Install FFmpeg +-------------- + +`Download FFmpeg `_ + +Install from GitHub +------------------- + +.. code-block:: bash + :linenos: + + git clone https://github.com/fabquenneville/MediaCurator.git + cd MediaCurator + pip install -r requirements.txt diff --git a/docs/_sources/usage/quickstart.rst.txt b/docs/_sources/usage/quickstart.rst.txt index e397aa5..f41ce4b 100644 --- a/docs/_sources/usage/quickstart.rst.txt +++ b/docs/_sources/usage/quickstart.rst.txt @@ -1,2 +1,4 @@ + +========== Quickstart ========== \ 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 853d4f5..21de4bb 100644 --- a/docs/_sources/usage/use_cases.rst.txt +++ b/docs/_sources/usage/use_cases.rst.txt @@ -1,2 +1,4 @@ + +========= Use cases ========= \ No newline at end of file diff --git a/docs/index.html b/docs/index.html index 234bb5f..ddd2802 100644 --- a/docs/index.html +++ b/docs/index.html @@ -38,20 +38,24 @@ -
-

Indices and tables

+

Indices and tables

+
diff --git a/docs/searchindex.js b/docs/searchindex.js index 4ad163d..77e6e58 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,Use:0,audio:1,big:1,big_valu:1,chapter:1,content:0,damag:1,decod:1,error:0,found:1,frame:1,header:1,index:0,instal:0,miss:1,modul:0,mpeg:1,page:0,quickstart:0,referenc:1,search:0,sei:1,too:1,track:1,type:1},titles:["Welcome to MediaCurator\u2019s documentation!","Errors","Installation","Quickstart","Use cases"],titleterms:{"case":4,Use:4,document:0,error:1,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/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 diff --git a/docs/usage/installation.html b/docs/usage/installation.html index 26f48a3..5ffdb59 100644 --- a/docs/usage/installation.html +++ b/docs/usage/installation.html @@ -36,6 +36,21 @@

Installation

+

This package (For now) will only work on GNU/Linux and requires FFMPEG installed. For now it will be distributed on GitHub

+
+

Install FFmpeg

+

Download FFmpeg

+
+
+

Install from GitHub

+
1
+2
+3
 git clone https://github.com/fabquenneville/MediaCurator.git
+ cd MediaCurator
+ pip install -r requirements.txt
+
+
+
@@ -60,7 +75,11 @@

Navigation

Contents: