Merge pull request #269 from unit8co/fix/doc

Fix/doc
unit8co · Feb 3, 2021 · c77a6bd · c77a6bd
2 parents 1ab231f + d4d6113
commit c77a6bd
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 68 deletions.
diff --git a/Dockerfile b/Dockerfile
@@ -23,6 +23,4 @@ ADD . /home/jovyan/work
 
 WORKDIR /home/jovyan/work
 
-RUN pip install -q .
-RUN pip install -q -r requirements/dev.txt
-
+RUN pip install .['all']
diff --git a/TODO.md b/TODO.md
diff --git a/build.gradle b/build.gradle
@@ -70,18 +70,17 @@ for(String flavour : flavours) {
     createPipInstallTask(flavour);
 }
 
+task installLocally(type:Exec) {
+    commandLine "pip", "install", ".[all]"
+}
+
 task pipInstall() {
     doFirst {
         setupPip
     }
     dependsOn pip_core, pip_dev, pip_fbprophet, pip_pmdarima, pip_torch, pip_release
 }
 
-task installLocally(type:Exec) {
-    dependsOn pipInstall
-    commandLine "pip", "install", "."
-}
-
 // Tests
 void coverageTestSteps() {
     exec {
@@ -142,7 +141,7 @@ task test_all() {
 def exampleName=project.properties["exampleName"] ?: ""
 
 task checkExample(type: Exec) {
-    dependsOn installLocally
+    dependsOn pipInstall, installLocally
     workingDir "./examples"
     // exampleName must be passed with -PexampleName=FFT-examples.ipynb
     commandLine "papermill", exampleName, exampleName
@@ -175,7 +174,7 @@ task cleanDocs(type: Exec) {
 }
 
 task buildDocs() {
-    dependsOn pipInstall
+    dependsOn pip_core, pip_release, installLocally
     dependsOn cleanDocs
     doLast {
         docSteps()

diff --git a/docs/source/examples.rst b/docs/source/examples.rst
@@ -5,7 +5,6 @@ Examples
 Here you will find some example notebooks to get more familiar with the API.
 
 
-
 darts intro
 ===========
 
@@ -18,7 +17,7 @@ You will find below an example Jupyter notebook containing an intro to the usage
 
 
 Multiple Time Series, Pre-trained Models and Covariates
-===========
+=======================================================
 
 You will find below an example Jupyter notebook showcasing models trained on multiple time series, pre-trained models, and the usage of covariates.
 
@@ -28,17 +27,6 @@ You will find below an example Jupyter notebook showcasing models trained on mul
    examples/02-multi-time-series-and-covariates.ipynb
 
 
-Training on multiple series and using Covariates
-================================================
-
-You will find below a Jupyter notebook containing a tutorial to darts *global models*,
-training on multiple series, and using covariates.
-
-.. toctree::
-   :maxdepth: 1
-
-   examples/multi-time-series-and-covariates.ipynb
-
 Data (pre) Processing
 =====================
 

diff --git a/requirements/release.txt b/requirements/release.txt
@@ -1,16 +1,16 @@
 # docs
 sphinx==3.2.1
-sphinx-automodapi
-sphinx_autodoc_typehints
-nbsphinx
-pydata-sphinx-theme
-recommonmark
+sphinx-automodapi==0.13
+sphinx_autodoc_typehints==1.11.1
+nbsphinx==0.8.0
+pydata-sphinx-theme==0.4.1
+recommonmark==0.7.1
 # Do not change it due to https://github.com/sphinx-doc/sphinx/issues/7420
 m2r @ git+https://github.com/crossnox/m2r@dev#egg=m2r
 
 # publish
-twine>=3.0.0
-bump2version
-ipykernel
-papermill
-ipywidgets
+twine==3.3.0
+bump2version==1.0.1
+ipykernel==5.3.4
+papermill==2.2.2
+ipywidgets==7.5.1