fix docs/index.rst

.gitlab-ci.yml

@@ -16,22 +16,9 @@ test_PyWake:  # name the job what we like
   - pytest
   tags:  # only runners with this tag can do the job [3]
   - ci-ubuntu
-
-## ===== TEST PyWake debian=====
-#test_PyWake_python3.6:  # name the job what we like
-#  image:   continuumio/anaconda3:5.2.0
-#  stage:  # build, test, deploy defined by default [2]
-#    test
-#  script:
-#  - apt update
-#  - apt install libgl1-mesa-glx -y
-#  - python -m pip install --upgrade --force-reinstall pip
-#  - pip install tensorflow --user
-#  - pip install -e .[test] --timeout 3600 --default-timeout=3600
-#  - python -c "from pathlib import Path; Path('matplotlibrc').write_text('backend'+chr(58)+' Agg')"
-#  - pytest
-#  tags:  # only runners with this tag can do the job [3]
-#  - ci-ubuntu
+  rules:
+    - if: $CI_COMMIT_BRANCH == "master"
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
 
 
 
@@ -44,6 +31,9 @@ check_code_style:  # name the job what we like
   - pycodestyle --ignore=E501,W504,E741 py_wake
   tags:  # only runners with this tag can do the job [3]
   - ci-ubuntu
+  rules:
+  - if: $CI_COMMIT_BRANCH == "master"
+  - if: $CI_PIPELINE_SOURCE == "merge_request_event"
 
 # ===== TEST PyWake on Windows =====
 test_PyWake_windows:  # name the job what we like
@@ -58,6 +48,9 @@ test_PyWake_windows:  # name the job what we like
   - pytest --cov-report term-missing:skip-covered --cov=py_wake --cov-config .coveragerc
   tags:  # tag for shared runner on windows machine
   - ANMH_old
+  rules:
+    - if: $CI_COMMIT_BRANCH == "master"
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
 
 # ===== Trigger PyWakePark pipeline =====
 trigger_pywake_park_test:
@@ -92,10 +85,11 @@ trigger_hub_test:
   only:
     - master
 
+
 # ===== build documentation =====
-pages:  # "pages" is a job specifically for GitLab pages [1]
+build_pages:  # "pages" is a job specifically for GitLab pages [1]
   stage:  # build, test, deploy defined by default [2]
-    deploy
+    test
   script:  # use sphinx to build docs, move to public page
   - apt-get update
   - apt-get -y install make pandoc graphviz
@@ -118,17 +112,38 @@ pages:  # "pages" is a job specifically for GitLab pages [1]
   - pwd
   - make html
   #- make latexpdf
-  - cd ../; mv docs/build/html public/
+  - cd ../
+  artifacts:  # required for GitLab pages [1]
+    paths:
+    - docs/build/html
+  rules:
+    - if: $CI_COMMIT_BRANCH == "master"
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: manual
+  tags:  # only runners with this tag can do the job [3]
+  - ci-ubuntu
+
+
+# ===== publish documentation =====
+pages:  # "pages" is a job specifically for GitLab pages [1]
+  stage:  # build, test, deploy defined by default [2]
+    deploy
+  dependencies: 
+    - build_pages
+  script:  # use sphinx to build docs, move to public page
+  - mv docs/build/html public/
   artifacts:  # required for GitLab pages [1]
     paths:
     - public
-  only:  # only run for these branches
-  - /^test_docdeploy.*/ 
-  - master
+  rules:
+    - if: $CI_COMMIT_BRANCH == "master"
+    - if: $CI_PIPELINE_SOURCE == "merge_request_event"
+      when: manual
   tags:  # only runners with this tag can do the job [3]
   - ci-ubuntu
 
 
+
 pypi_linux:
   stage:
     deploy

docs/index.rst

@@ -39,9 +39,9 @@ PyWake is equipped with many capabilities that can range from basic to complex.
 
 Explanations of PyWake's core objects can be found in the following tutorials:
 
-* :ref:`Site </notebooks/Site.ipynb>`: this tutorial walks through the set up of pre-defined sites in PyWake as well as the possibility for user-defined sites.
-* :ref:`Wind Turbine </notebooks/WindTurbines.ipynb>`: this example demonstrates how to set up a wind turbine object and also to create user-defined turbines with specific power and CT curves.
-* :ref:`Engineering Wind Farm Models </notebooks/EngineeringWindFarmModels.ipynb>`: here there is a detailed explanation of all the wake deficit models available in PyWake as well as other engineering models such as wake superposition, deflection, etc.
+	* :ref:`Site </notebooks/Site.ipynb>`: this tutorial walks through the set up of pre-defined sites in PyWake as well as the possibility for user-defined sites.
+	* :ref:`Wind Turbine </notebooks/WindTurbines.ipynb>`: this example demonstrates how to set up a wind turbine object and also to create user-defined turbines with specific power and CT curves.
+	* :ref:`Engineering Wind Farm Models </notebooks/EngineeringWindFarmModels.ipynb>`: here there is a detailed explanation of all the wake deficit models available in PyWake as well as other engineering models such as wake superposition, deflection, etc.
 
 The :ref:`Wind farm simulation </notebooks/RunWindFarmSimulation.ipynb>` example shows how to execute PyWake and extract relevant information about the wind farm studied. In addition, PyWake's capablities to calculate gradients are demonstrated in the :ref:`Gradients, parallelization and precision </notebooks/gradients_parallellization.ipynb>` example, and an optimization with TOPFARM is available in the :ref:`Optimization </notebooks/Optimization.ipynb>` tutorial.
 
@@ -50,7 +50,7 @@ Lastly, the remaining notebooks illustrate some relevant examples and exercises
 
     .. toctree::
         :maxdepth: 1
-:caption: Contents
+	:caption: Contents
     
         installation
         notebooks/Overview  
@@ -59,7 +59,7 @@ Lastly, the remaining notebooks illustrate some relevant examples and exercises
                
     .. toctree::
         :maxdepth: 1
-:caption: Tutorials
+	:caption: Tutorials
        
         notebooks/Quickstart
         notebooks/Site
@@ -77,19 +77,19 @@ Lastly, the remaining notebooks illustrate some relevant examples and exercises
 
     .. toctree::
         :maxdepth: 1
-:caption: Model Verification       
+	:caption: Model Verification       
 
         notebooks/literature_verification/TurbOPark
         
     .. toctree::
         :maxdepth: 2
-:caption: Validation
+	:caption: Validation
     
         validation
         
     .. toctree::
         :maxdepth: 1
-:caption: API Reference
+	:caption: API Reference
             
         api/WindTurbines
         api/Site