diff --git a/.github/workflows/check-pr-docs-build.yml b/.github/workflows/check-pr-docs-build.yml index 18b78c82..059776b8 100644 --- a/.github/workflows/check-pr-docs-build.yml +++ b/.github/workflows/check-pr-docs-build.yml @@ -11,8 +11,7 @@ on: env: - # Uncomment the following line to enable custom CNAME for documentation - # DOCUMENTATION_CNAME: 'visor.staging.local' + DOCUMENTATION_CNAME: 'visor.docs.pyansys.com' MAIN_PYTHON_VERSION: '3.11' diff --git a/.github/workflows/nightly-docs.yml b/.github/workflows/nightly-docs.yml index a51b815c..5cb4c165 100644 --- a/.github/workflows/nightly-docs.yml +++ b/.github/workflows/nightly-docs.yml @@ -9,8 +9,7 @@ on: tags: [ 'v*' ] env: - # Uncomment the following line to enable custom CNAME for documentation - # DOCUMENTATION_CNAME: 'visor.staging.local' + DOCUMENTATION_CNAME: 'visor.docs.pyansys.com' MAIN_PYTHON_VERSION: '3.11' GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} @@ -56,8 +55,7 @@ jobs: - name: Deploy development documentation uses: ansys/actions/doc-deploy-dev@v10 with: - # Uncomment the following line to enable custom CNAME for documentation - # cname: ${{ env.DOCUMENTATION_CNAME }} + cname: ${{ env.DOCUMENTATION_CNAME }} token: ${{ secrets.GITHUB_TOKEN }} bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }} bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }} @@ -70,6 +68,7 @@ jobs: - name: Deploy stable documentation uses: ansys/actions/doc-deploy-stable@v10 with: + cname: ${{ env.DOCUMENTATION_CNAME }} token: ${{ secrets.GITHUB_TOKEN }} bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }} bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }} \ No newline at end of file diff --git a/doc/changelog.d/37.documentation.md b/doc/changelog.d/37.documentation.md new file mode 100644 index 00000000..ff1ace56 --- /dev/null +++ b/doc/changelog.d/37.documentation.md @@ -0,0 +1 @@ +Configure CNAME for VISOR docs diff --git a/doc/source/conf.py b/doc/source/conf.py index 7be3e345..c9cb87f0 100644 --- a/doc/source/conf.py +++ b/doc/source/conf.py @@ -11,9 +11,7 @@ from ansys.visor.viewer import __version__ -# TODO: Set up namespace for VISOR docs and update here -# visor_cname = "visor.docs.solutions.ansys.com" -visor_cname = "vigilant-lamp-162kw9z.pages.github.io" +visor_cname = "visor.docs.pyansys.com" cname = os.getenv("DOCUMENTATION_CNAME", visor_cname) """The canonical name of the webpage hosting the documentation."""