Fix doc build auth (#810)

* use github application for auth

* use correct token

* trigger always for testing

* use token for both; switch to new target repo for docs

* try new port

* use 21000 for all workflows

Author: akaszynski

.github/workflows/ci.yml

@@ -10,7 +10,7 @@ on:
       - main
 
 env:
-  PYMAPDL_PORT: 32771  # default won't work on azure
+  PYMAPDL_PORT: 21000  # default won't work on azure
   PYMAPDL_START_INSTANCE: FALSE
   PYANSYS_OFF_SCREEN: True
   DOCKER_PACKAGE: docker.pkg.github.com/pyansys/pymapdl/mapdl
@@ -88,6 +88,14 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
+      # used for documentation deployment
+      - name: Get Bot Application Token
+        id: get_workflow_token
+        uses: peter-murray/workflow-application-token-action@v1
+        with:
+          application_id: ${{ secrets.BOT_APPLICATION_ID }}
+          application_private_key: ${{ secrets.BOT_APPLICATION_PRIVATE_KEY }}
+
       - name: Setup Python
         uses: actions/setup-python@v2
         with:
@@ -152,7 +160,6 @@ jobs:
         working-directory: doc
         run: |
           # Overwrite MAPDL commands section so it doesn't show up
-          mv source/mapdl_commands/.fake source/mapdl_commands/index.rst
           make latex
           python validate_png.py  # clean-up GIFs mislabeled as PNG
           cd build/latex
@@ -163,16 +170,18 @@ jobs:
         uses: actions/upload-artifact@v2
         with:
           name: PDF-Documentation
-          path: doc/build/latex/pymapdl.pdf
+          path: doc/build/latex/pymapdl*.pdf
           retention-days: 7
 
       - name: Deploy
-        uses: JamesIves/github[email protected]
-        if: startsWith(github.ref, 'refs/tags/')
+        if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+        uses: JamesIves/github[email protected]
         with:
-          token: ${{ secrets.GITHUB_TOKEN }}
-          branch: gh-pages
-          folder: doc/build/html
+          repository-name: pyansys/pymapdl-docs
+          token: ${{ steps.get_workflow_token.outputs.token }}
+          BRANCH: gh-pages
+          FOLDER: doc/build/html
+          CLEAN: true
 
   build_test:
     name: Build and Unit Testing
@@ -269,4 +278,4 @@ jobs:
         with:
           files: |
             ./**/*.whl
-            ./**/*.pdf
+            ./**/*.pdf

.github/workflows/nightly-doc-build.yml

@@ -12,22 +12,30 @@ jobs:
     env:
       DISPLAY: ':99.0'
       MAPDL_IMAGE: 'docker.pkg.github.com/pyansys/pymapdl/mapdl:v21.2.1'
-      PYMAPDL_PORT: 32771  # default won't work on azure
+      PYMAPDL_PORT: 21000  # default won't work on azure
       PYMAPDL_START_INSTANCE: FALSE
       PYANSYS_OFF_SCREEN: True
 
     steps:
       - uses: actions/checkout@v2
 
+      # used for documentation deployment
+      - name: Get Bot Application Token
+        id: get_workflow_token
+        uses: peter-murray/workflow-application-token-action@v1
+        with:
+          application_id: ${{ secrets.BOT_APPLICATION_ID }}
+          application_private_key: ${{ secrets.BOT_APPLICATION_PRIVATE_KEY }}
+
       - name: Setup Python
         uses: actions/setup-python@v2
         with:
           python-version: 3.8
 
       - name: Install OS packages
         run: |
-          sudo apt update
-          sudo apt install libgl1-mesa-glx xvfb
+          sudo apt-get update
+          sudo apt-get install libgl1-mesa-glx xvfb pandoc -qy
 
       - name: Install ansys-mapdl-core
         run: |
@@ -50,15 +58,14 @@ jobs:
 
       - name: Build Documentation
         run: |
-          sudo apt install pandoc -qy
           pip install -r requirements_docs.txt
           xvfb-run make -C doc html
 
       - name: Deploy
         uses: JamesIves/[email protected]
         with:
           repository-name: pyansys/pymapdl-dev-docs
-          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+          token: ${{ steps.get_workflow_token.outputs.token }}
           BRANCH: gh-pages
           FOLDER: doc/build/html
           CLEAN: true

.github/workflows/nightly-mapdl-check.yml

@@ -8,7 +8,7 @@ on:
     - cron:  '0 4 * * *'
 
 env:
-  PYMAPDL_PORT: 32771  # default won't work on azure
+  PYMAPDL_PORT: 21000  # default won't work on azure
   PYMAPDL_START_INSTANCE: FALSE
   PYANSYS_OFF_SCREEN: True
 

doc/source/conf.py

@@ -1,3 +1,5 @@
+"""Sphinx documentation configuration file."""
+from datetime import datetime
 import os
 import warnings
 
@@ -36,7 +38,7 @@
 # -- Project information -----------------------------------------------------
 
 project = "ansys.mapdl.core"
-copyright = "(c) 2021 ANSYS, Inc. All rights reserved"
+copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
 author = "ANSYS Inc."
 
 # The short X.Y version

doc/source/index.rst

@@ -1,5 +1,5 @@
-PyMAPDL Documentation
-=====================
+PyMAPDL Documentation |version|
+===============================
 
 .. toctree::
    :hidden: