Nrichers/sc 12743/fix quarto docs workflow issue (#1001)

* Remove validmind/ folder and old python-docs.zip file

* Change make python-docs to generate the Python API files

* Add site/validmind to the .gitignore

* Add make python-docs equivalent to workflows

* Try RELEASE_NOTES_RO_PAT

Author: nrichers

.github/workflows/deploy-docs-prod.yaml

@@ -33,6 +33,13 @@ jobs:
           apt_cleanup: "true"
           create_reserve_gb: "3"
 
+      - name: Check out validmind-library repository
+        uses: actions/checkout@v4
+        with:
+          repository: validmind/validmind-library
+          path: site/_source/validmind-library
+          token: ${{ secrets.RELEASE_NOTES_RO_PAT }}
+
       - name: Check out installation repository
         uses: actions/checkout@v4
         with:
@@ -55,6 +62,15 @@ jobs:
       - name: Setup R environment
         uses: ./.github/actions/setup-r
 
+      - name: Generate Python library docs
+        run: |
+          cd site/_source/validmind-library
+          make install && make quarto-docs
+          cd ../../
+          rm -rf validmind
+          mkdir -p validmind
+          rsync -av --exclude '_build' --exclude 'templates' _source/validmind-library/docs/ validmind/
+
       - name: Populate installation
         run: cp -r site/_source/installation/site/installation site/installation
 

.github/workflows/deploy-docs-staging.yaml

@@ -33,6 +33,13 @@ jobs:
           apt_cleanup: "true"
           create_reserve_gb: "3"
 
+      - name: Check out validmind-library repository
+        uses: actions/checkout@v4
+        with:
+          repository: validmind/validmind-library
+          path: site/_source/validmind-library
+          token: ${{ secrets.RELEASE_NOTES_RO_PAT }}
+
       - name: Check out installation repository
         uses: actions/checkout@v4
         with:
@@ -54,6 +61,15 @@ jobs:
 
       - name: Setup R environment
         uses: ./.github/actions/setup-r
+
+      - name: Generate Python library docs
+        run: |
+          cd site/_source/validmind-library
+          make install && make quarto-docs
+          cd ../../
+          rm -rf validmind
+          mkdir -p validmind
+          rsync -av --exclude '_build' --exclude 'templates' _source/validmind-library/docs/ validmind/
   
       - name: Populate installation
         run: cp -r site/_source/installation/site/installation site/installation

.github/workflows/validate-docs-site.yaml

@@ -28,6 +28,13 @@ jobs:
         apt_cleanup: "true"
         create_reserve_gb: "3"
 
+    - name: Check out validmind-library repository
+      uses: actions/checkout@v4
+      with:
+        repository: validmind/validmind-library
+        path: site/_source/validmind-library
+        token: ${{ secrets.RELEASE_NOTES_RO_PAT }}
+        
     - name: Check out installation repository
       uses: actions/checkout@v4
       with:
@@ -50,6 +57,15 @@ jobs:
     - name: Setup R environment
       uses: ./.github/actions/setup-r
 
+    - name: Generate Python library docs
+      run: |
+        cd site/_source/validmind-library
+        make install && make quarto-docs
+        cd ../../
+        rm -rf validmind
+        mkdir -p validmind
+        rsync -av --exclude '_build' --exclude 'templates' _source/validmind-library/docs/ validmind/
+
     - name: Populate installation
       run: cp -r site/_source/installation/site/installation site/installation
 

.gitignore

@@ -31,3 +31,6 @@ site/releases/validmind-library
 
 # Generated ConfigMap for Docker profile
 site/validmind-docs.yaml
+
+# Python API docs are now generated on the fly
+site/validmind

site/Makefile

@@ -324,12 +324,12 @@ notebooks:
 
 # Make Python library docs & copy them over
 python-docs:
-	@if [ -d "$(SRC_DIR)/docs" ]; then \
-		echo "\nUpdating Python source ..."; \
-		rm -rf $(DEST_DIR_PYTHON); \
-		mkdir -p $(DEST_DIR_PYTHON); \
-		rsync -av --exclude '_build' --exclude 'templates' $(SRC_DIR)/docs/ $(DEST_DIR_PYTHON)/; \
-	fi
+	echo "\nUpdating Python source ...";
+	@cd _source/validmind-library && make install && make quarto-docs;
+	@cd ../../;
+	rm -rf $(DEST_DIR_PYTHON);
+	mkdir -p $(DEST_DIR_PYTHON);
+	rsync -av --exclude '_build' --exclude 'templates' $(SRC_DIR)/docs/ $(DEST_DIR_PYTHON)/; 
 
 # Release notes target
 release-notes: