MAINT: update package layout and continuous deployment (#268)

* DOC: tox doc output to doc/_build/html

* CI: renmae ci-build.yml -> ci_cd.yml

* MAINT: point codespell to Vale words

* MAINT: remove unnecessary Makefile

* DOC: format Python examples

* DOC: accept 'param' word

* CI: update workflows

* CI: update version naming

Author: jorgepiloto

.github/workflows/ci-build.yml renamed to .github/workflows/ci_cd.yml

@@ -10,7 +10,7 @@ on:
 
 env:
   MAIN_PYTHON_VERSION: '3.10'
-  CNAME: 'dev.docs.pyansys.com'
+  DOCUMENTATION_CNAME: 'dev.docs.pyansys.com'
 
 concurrency:
   group: ${{ github.workflow }}-${{ github.ref }}
@@ -53,23 +53,11 @@ jobs:
           requires-xvfb: true
           dependencies: 'xvfb texlive-latex-extra latexmk nodejs npm'
 
-  doc-deploy:
-    name: "Deploy development documentation"
-    runs-on: ubuntu-latest
-    if: ${{ github.ref == 'refs/heads/main' }}
-    needs: doc-build
-    steps:
-      - name: "Deploy development documentation"
-        uses: pyansys/actions/doc-deploy-dev@v3
-        with:
-          cname: ${{ env.CNAME }}
-          token: ${{ secrets.GITHUB_TOKEN }}
-
   release-github:
     name: "Release to GitHub"
     runs-on: ubuntu-latest
-    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
-    needs: doc-deploy
+    if: github.ref == 'refs/heads/main'
+    needs: doc-build
     steps:
 
     - name: "Download HTML documentation"
@@ -106,3 +94,17 @@ jobs:
         files: |
           documentation-html.zip
           documentation-pdf
+
+  doc-deploy:
+    name: "Deploy documentation"
+    runs-on: ubuntu-latest
+    if: github.ref == 'refs/heads/main'
+    needs: release-github
+    steps:
+      - uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/_build/html
+          cname: ${{ env.DOCUMENTATION_CNAME }}
+          full_commit_message: ${{ github.event.head_commit.message }}
+          force_orphan: true

.pre-commit-config.yaml

@@ -5,7 +5,10 @@ repos:
   rev: 23.1.0  # IF VERSION CHANGES --> MODIFY "blacken-docs" MANUALLY AS WELL!!
   hooks:
   - id: black
-    args: ["doc/source/conf.py"]
+    args: [
+      "doc/source/conf.py",
+      "examples"
+    ]
 
 - repo: https://github.com/adamchainz/blacken-docs
   rev: 1.13.0
@@ -29,10 +32,10 @@ repos:
   - id: flake8
 
 - repo: https://github.com/codespell-project/codespell
-  rev: v2.2.2
+  rev: v2.2.1
   hooks:
   - id: codespell
-    args: [--ignore-words=ignore_words.txt, -S \*.pyc\,\*.xml\,\*.txt\,\*.gif\,\*.png\,\*.jpg\,\*.js\,\*.html\,\*.doctree\,\*.ttf\,\*.woff\,\*.woff2\,\*.eot\,\*.mp4\,\*.inv\,\*.pickle\,\*.ipynb\,flycheck\*\,./.git/\*\,./.hypothesis/\*\,\*.yml\,./doc/build/\*\,./doc/images/\*\,./dist/\*\,\*~\,.hypothesis\*\,./doc/source/examples/\*\,\*cover\,\*.dat\,\*.mac]
+    args: ["--ignore-words", "doc/styles/Vocab/ANSYS/accept.txt"]
 
 - repo: https://github.com/pre-commit/pre-commit-hooks
   rev: v4.4.0

Makefile

@@ -17,7 +17,7 @@
 project = "PyAnsys Developer's Guide"
 copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
 author = "Ansys Inc."
-release = version = "0.3.dev0"
+release = version = datetime.now().strftime("%Y-%m-%d")
 
 html_logo = pyansys_logo_black
 html_theme = "ansys_sphinx_theme"

doc/source/conf.py

@@ -85,3 +85,4 @@ Muela
 Kaszynski
 cybersecurity
 substring
+parm

doc/styles/Vocab/ANSYS/accept.txt

@@ -32,6 +32,4 @@ deps =
     -r{toxinidir}/requirements/requirements_doc.txt
 allowlist_externals=*
 commands = 
-    sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxworkdir}/doc_out_html" --color -vW -b html
-    touch "{toxworkdir}/doc_out_html/.nojekyll"
-    bash -c 'echo "dev.docs.pyansys.com" > "{toxworkdir}/doc_out_html/CNAME"'
+    sphinx-build -d "{toxworkdir}/doc_doctree" doc/source "{toxinidir}/doc/_build/html" --color -vW -b html