TVB-3135. Generate online help.

Author: popaula937

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

@@ -39,12 +39,12 @@ jobs:
 #          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: Prepare tag for Docker image
         # At release time, the tag will be given as input
@@ -57,10 +57,16 @@ jobs:
             echo "TAG=${{ github.ref_name }}.alpha" >> $GITHUB_OUTPUT
           fi
 
-      - name: Prepare TVB online help ZIP
-        #TODO: generate this
+      - name: set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.13"
+
+      - name: Prepare TVB online help
         run: |
-          mkdir tvb_build/docker/step1 && mkdir tvb_build/docker/step1/_help
+          python3 -m pip install sphinx
+          python3 build_step1.py ${{ github.ref_name }} True
+          ls tvb_build/docker
 
       - name: Build Docker image
         uses: docker/build-push-action@v6

tvb_build/build_step1.py

@@ -58,6 +58,7 @@
 
 # dest paths
 DIST_FOLDER = os.path.join(os.path.dirname(__file__), 'build', 'TVB_Distribution')
+DOCKER_FOLDER = os.path.join(os.path.dirname(__file__), 'docker', 'step1')
 
 DATA_INSIDE_FOLDER = os.path.join(DIST_FOLDER, '_tvb_data')
 
@@ -204,7 +205,7 @@ def ensure_tvb_current_revision(branch=None, token=None):
             print("Updating tvb.version content in %s to: %s because %d != %d" % (path, new_text, written_tvb_number, real_version_number))
 
 
-def build_step1():
+def build_step1(only_online_help=False):
     # Import only after TVB Revision number has been changed, to get the latest number in generated documentation
     from tvb_build.tvb_documentor.doc_generator import DocGenerator
 
@@ -221,8 +222,16 @@ def build_step1():
     # make help HTML, PDF manual and documentation site
     print("Starting to populate %s" % DIST_FOLDER)
     doc_generator = DocGenerator(TVB_ROOT, DIST_FOLDER)
-    doc_generator.generate_pdfs()
     doc_generator.generate_online_help()
+
+    if only_online_help:
+        if os.path.exists(DOCKER_FOLDER):
+            shutil.rmtree(DOCKER_FOLDER)
+        os.makedirs(DOCKER_FOLDER)
+        shutil.move(DIST_FOLDER, DOCKER_FOLDER)
+        return
+
+    doc_generator.generate_pdfs()
     doc_generator.generate_site()
 
     shutil.copy2(LICENSE_PATH, os.path.join(DIST_FOLDER, 'LICENSE_TVB.txt'))
@@ -248,8 +257,11 @@ def build_step1():
         branch = sys.argv[1]
         if branch.startswith("origin/"):
             branch = branch.replace("origin/","")
-    token = None
+    # 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:
-        token = sys.argv[2]
-    ensure_tvb_current_revision(branch, token)
-    build_step1()
+        only_online_help = bool(sys.argv[3])
+    build_step1(only_online_help)