Add environment file to build docs workflow

Author: antonwolfy

.github/workflows/build-sphinx.yml

@@ -102,51 +102,58 @@ jobs:
           fetch-depth: 0
 
       - name: Setup miniconda
-        id: setup_miniconda
-        continue-on-error: true
         uses: conda-incubator/setup-miniconda@d2e6a045a86077fb6cad6f5adf368e9076ddaa8d # v3.1.0
         with:
           miniforge-version: latest
           use-mamba: 'true'
-          channels: conda-forge
-          conda-remove-defaults: 'true'
-          python-version: ${{ env.python-ver }}
-          activate-environment: 'docs'
-
-      - name: ReSetup miniconda
-        if: steps.setup_miniconda.outcome == 'failure'
-        uses: conda-incubator/setup-miniconda@d2e6a045a86077fb6cad6f5adf368e9076ddaa8d # v3.1.0
-        with:
-          miniforge-version: latest
-          use-mamba: 'true'
-          channels: conda-forge
-          conda-remove-defaults: 'true'
-          python-version: ${{ env.python-ver }}
-          activate-environment: 'docs'
+          environment-file: 'environments/build_docs.yml'
+
+      # - name: Setup miniconda
+      #   id: setup_miniconda
+      #   continue-on-error: true
+      #   uses: conda-incubator/setup-miniconda@d2e6a045a86077fb6cad6f5adf368e9076ddaa8d # v3.1.0
+      #   with:
+      #     miniforge-version: latest
+      #     use-mamba: 'true'
+      #     channels: conda-forge
+      #     conda-remove-defaults: 'true'
+      #     python-version: ${{ env.python-ver }}
+      #     activate-environment: 'docs'
+
+      # - name: ReSetup miniconda
+      #   if: steps.setup_miniconda.outcome == 'failure'
+      #   uses: conda-incubator/setup-miniconda@d2e6a045a86077fb6cad6f5adf368e9076ddaa8d # v3.1.0
+      #   with:
+      #     miniforge-version: latest
+      #     use-mamba: 'true'
+      #     channels: conda-forge
+      #     conda-remove-defaults: 'true'
+      #     python-version: ${{ env.python-ver }}
+      #     activate-environment: 'docs'
 
       # Sometimes `mamba install ...` fails due to slow download speed rate, so disable the check in mamba
-      - name: Disable speed limit check in mamba
-        run: echo "MAMBA_NO_LOW_SPEED_LIMIT=1" >> $GITHUB_ENV
+      # - name: Disable speed limit check in mamba
+      #   run: echo "MAMBA_NO_LOW_SPEED_LIMIT=1" >> $GITHUB_ENV
 
-      - name: Install sphinx dependencies
-        run: |
-          mamba install sphinx sphinx_rtd_theme
-          pip install sphinxcontrib-googleanalytics==0.4 \
-            pyenchant sphinxcontrib-spelling
+      # - name: Install sphinx dependencies
+      #   run: |
+      #     mamba install sphinx sphinx_rtd_theme
+      #     pip install sphinxcontrib-googleanalytics==0.4 \
+      #       pyenchant sphinxcontrib-spelling
 
-      - name: Install dpnp dependencies
-        if: env.INSTALL_ONE_API == 'yes'
-        run: |
-          mamba install numpy dpctl">=0.18.0dev0" cmake cython pytest ninja scikit-build ${{ env.NO_INTEL_CHANNELS }}
+      # - name: Install dpnp dependencies
+      #   if: env.INSTALL_ONE_API == 'yes'
+      #   run: |
+      #     mamba install numpy dpctl">=0.18.0dev0" cmake cython pytest ninja scikit-build ${{ env.NO_INTEL_CHANNELS }}
 
-      - name: Install dpnp dependencies
-        if: env.INSTALL_ONE_API != 'yes'
-        run: |
-          mamba install numpy dpctl">=0.18.0dev0" mkl-devel-dpcpp onedpl-devel tbb-devel dpcpp_linux-64 \
-              cmake cython pytest ninja scikit-build ${{ env.CHANNELS }}
+      # - name: Install dpnp dependencies
+      #   if: env.INSTALL_ONE_API != 'yes'
+      #   run: |
+      #     mamba install numpy dpctl">=0.18.0dev0" mkl-devel-dpcpp onedpl-devel tbb-devel dpcpp_linux-64 \
+      #         cmake cython pytest ninja scikit-build ${{ env.CHANNELS }}
 
-      - name: Install cuPy dependencies
-        run: mamba install cupy
+      # - name: Install cuPy dependencies
+      #   run: mamba install cupy
 
       - name: Conda info
         run: mamba info
@@ -178,7 +185,6 @@ jobs:
           echo PROJECT_NUMBER=${PROJECT_NUMBER}
           echo "PROJECT_NUMBER=$PROJECT_NUMBER" >> $GITHUB_ENV
 
-      # https://github.com/marketplace/actions/doxygen-action
       - name: Build backend docs
         uses: mattnotmitt/doxygen-action@cbe72c8e402e8a3faa1f0b247ef90aa6c8e4ce74 # v1.9.8
         with:
@@ -187,7 +193,6 @@ jobs:
       - name: Copy backend docs
         run: cp -r dpnp/backend/doc/html ${{ env.PUBLISH_DIR }}/backend_doc
 
-      # https://github.com/marketplace/actions/github-pages-action
       # The step is only used to build docs while pushing a PR to "master"
       - name: Deploy docs
         if: env.GH_EVENT_PUSH_UPSTREAM == 'true'

environments/build_docs.txt

@@ -0,0 +1,3 @@
+pyenchant==3.2.2
+sphinxcontrib-googleanalytics==0.4
+sphinxcontrib-spelling==8.0.1

environments/build_docs.yml

@@ -0,0 +1,19 @@
+name: build_docs
+channels:
+  - dppy/label/dev
+  - conda-forge
+  - nodefaults
+dependencies:
+  - python=3.12
+  - cmake
+  - cupy
+  - cython
+  - dpctl>=0.19.0dev0
+  - ninja
+  - numpy
+  - pytest
+  - scikit-build
+  - sphinx
+  - sphinx_rtd_theme
+  - pip:
+    - -r build_docs.txt