[skip ci] TVB-3135. Generate online help.

Author: popaula937

.github/workflows/build-docker-image.yml

@@ -33,18 +33,33 @@ jobs:
       - name: Set up Docker Buildx
         uses: docker/setup-buildx-action@v3
 
-#      - name: Login to Docker Hub
-#        uses: docker/login-action@v3
-#        with:
-#          username: ${{ secrets.DOCKER_HUB_USERNAME }}
-#          password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+      - name: Login to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.DOCKER_HUB_PASSWORD }}
+
+      - name: Login to EBRAINS Docker Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ${{ env.DOCKER_EBRAINS_REGISTRY }}
+          username: ${{ secrets.EBRAINS_DOCKER_HUB_USERNAME }}
+          password: ${{ secrets.EBRAINS_DOCKER_HUB_PASSWORD }}
 
-#      - name: Login to EBRAINS Docker Registry
-#        uses: docker/login-action@v3
-#        with:
-#          registry: ${{ env.DOCKER_EBRAINS_REGISTRY }}
-#          username: ${{ secrets.EBRAINS_DOCKER_HUB_USERNAME }}
-#          password: ${{ secrets.EBRAINS_DOCKER_HUB_PASSWORD }}
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+
+      - name: Prepare TVB online help
+        run: |
+          python3 -m pip install sphinx
+          cd tvb_library
+          python3 -m pip install -e .
+          cd ../tvb_bin
+          python3 -m pip install -e .
+          cd ../tvb_build
+          python3 build_step1.py True
 
       - name: Prepare tag for Docker image
         # At release time, the tag will be given as input
@@ -57,18 +72,6 @@ jobs:
             echo "TAG=${{ github.ref_name }}.alpha" >> $GITHUB_OUTPUT
           fi
 
-      - name: set up Python
-        uses: actions/setup-python@v4
-        with:
-          python-version: "3.13"
-
-      - name: Prepare TVB online help
-        run: |
-          python3 -m pip install sphinx
-          cd tvb_build
-          python3 build_step1.py ${{ github.ref_name }} True
-          ls tvb_build/docker
-
       - name: Build Docker image
         uses: docker/build-push-action@v6
         with:

tvb_build/Jenkinsfile-Step1

@@ -28,7 +28,7 @@ pipeline {
                             source activate tvb-docs
                             cd tvb_build
                             bash install_full_tvb.sh
-                            python build_step1.py $GIT_BRANCH $GIT_PASSWORD
+                            python build_step1.py False $GIT_BRANCH $GIT_PASSWORD
                             cd ..
                             git commit tvb_library/tvb/basic/config/tvb.version -m "Update GIT revision number automatically from Jenkins" && git push https://${GIT_USERNAME}:${GIT_PASSWORD}@github.com/the-virtual-brain/tvb-root.git HEAD:${GIT_BRANCH//origin\\/} || true
                          '''

tvb_build/build_step1.py

@@ -44,16 +44,13 @@
 import requests
 
 import tvb_bin
-import tvb_data
-from subprocess import Popen, PIPE
 
 # source paths
 BIN_FOLDER = os.path.dirname(tvb_bin.__file__)
 TVB_ROOT = os.path.dirname(os.path.dirname(BIN_FOLDER))
 FW_FOLDER = os.path.join(TVB_ROOT, 'tvb_framework')
 LICENSE_PATH = os.path.join(FW_FOLDER, 'LICENSE')
 RELEASE_NOTES_PATH = os.path.join(TVB_ROOT, 'tvb_documentation', 'RELEASE_NOTES')
-DATA_SRC_FOLDER = os.path.dirname(tvb_data.__file__)
 DEMOS_MATLAB_FOLDER = os.path.join(TVB_ROOT, 'tvb_documentation', 'matlab')
 
 # dest paths
@@ -117,6 +114,9 @@
 
 
 def _copy_dataset(dataset_files, dataset_destination):
+    import tvb_data
+    DATA_SRC_FOLDER = os.path.dirname(tvb_data.__file__)
+
     for pth in dataset_files:
         rel_pth = pth.split('/')
         origin = os.path.join(DATA_SRC_FOLDER, *rel_pth)
@@ -228,7 +228,7 @@ def build_step1(only_online_help=False):
         if os.path.exists(DOCKER_FOLDER):
             shutil.rmtree(DOCKER_FOLDER)
         os.makedirs(DOCKER_FOLDER)
-        shutil.move(DIST_FOLDER, DOCKER_FOLDER)
+        shutil.move(os.path.join(DIST_FOLDER, "_help"), DOCKER_FOLDER)
         return
 
     doc_generator.generate_pdfs()
@@ -252,16 +252,17 @@ def build_step1(only_online_help=False):
 
 
 if __name__ == '__main__':
-    branch = None
+    only_online_help = False
     if len(sys.argv) > 1:
-        branch = sys.argv[1]
+        only_online_help = bool(sys.argv[1])
+    branch = None
+    if len(sys.argv) > 2:
+        branch = sys.argv[2]
         if branch.startswith("origin/"):
             branch = branch.replace("origin/","")
-    # token = None
-    # if len(sys.argv) > 2:
-    #     token = sys.argv[2]
-    # ensure_tvb_current_revision(branch, token)
-    only_online_help = False
-    if len(sys.argv) > 2:
-        only_online_help = bool(sys.argv[3])
+    token = None
+    if len(sys.argv) > 3:
+        token = sys.argv[3]
+    if token:
+        ensure_tvb_current_revision(branch, token)
     build_step1(only_online_help)