Merge branch 'main' into release/0.1

Author: akaszynski

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+exclude = build
+select = W191, W291, W293, W391, E115, E117, E122, E124, E125, E225, E231, E301, E303, E501, F401, F403
+count = True
+max-complexity = 10
+max-line-length = 100
+statistics = True

.github/workflows/ci-build.yml

@@ -1,19 +1,40 @@
-# Build documentation
-name: Documentation Build
+name: Build
 
-on: [push, pull_request, workflow_dispatch]
+on:
+  pull_request:
+  push:
+    tags:
+      - "*"
+    branches:
+      - main
 
 jobs:
-  docs_build:
-    runs-on: ubuntu-20.04
+  stylecheck:
+    runs-on: ubuntu-latest
 
     steps:
       - uses: actions/checkout@v2
 
       - name: Setup Python
         uses: actions/[email protected]
         with:
-          python-version: 3.8
+          python-version: 3.9
+
+      - name: Check Style
+        run: |
+          pip install -r requirements_style.txt --disable-pip-version-check
+          make
+
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup Python
+        uses: actions/[email protected]
+        with:
+          python-version: 3.9
 
       - name: Install pyansys_sphinx_theme
         run: |
@@ -23,10 +44,11 @@ jobs:
       - name: lint package
         run: |
           pip install twine
-          twine check dist/pyansys*
+          twine check dist/*
 
       - name: Build Documentation
         run: |
+          pip install -r requirements_docs.txt
           make -C doc html SPHINXOPTS="-W"
           touch doc/build/html/.nojekyll
           echo "sphinxdocs.pyansys.com" > doc/build/html/CNAME
@@ -48,11 +70,28 @@ jobs:
           CLEAN: true
           single-commit: true
 
-      - name: Upload to PyPi
-        if: startsWith(github.ref, 'refs/tags/')
+  Release:
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    needs: [stylecheck, build]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Set up Python
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+
+      - name: Generate package
+        run: python setup.py sdist
+
+      - name: Upload to Public PyPi
         run: |
           pip install twine
-          twine upload --skip-existing dist/pyansys*
+          twine upload --skip-existing dist/*
         env:
           TWINE_USERNAME: __token__
-          TWINE_PASSWORD: ${{ secrets.TWINE_TOKEN }}
+          TWINE_PASSWORD: ${{ secrets.PYPI_TOKEN }}
+
+      - name: Release
+        uses: softprops/action-gh-release@v1
+        with:
+          generate_release_notes: true

.github/workflows/style.yml

@@ -10,5 +10,7 @@ dist/*
 *.egg-info/
 
 
+# sphinx auto-generated
 build/*
-doc/build/
+doc/build/
+doc/source/_autosummary/

.gitignore

@@ -2,4 +2,5 @@
 include pyansys_sphinx_theme/docs-navbar.html
 include pyansys_sphinx_theme/theme.conf
 
+graft pyansys_sphinx_theme/_templates
 graft pyansys_sphinx_theme/static

MANIFEST.in

@@ -6,8 +6,12 @@ CODESPELL_IGNORE ?= "ignore_words.txt"
 
 all: doctest
 
-doctest: codespell
+doctest: codespell flake8
 
 codespell:
 	@echo "Running codespell"
 	@codespell $(CODESPELL_DIRS) -S $(CODESPELL_SKIP) -I $(CODESPELL_IGNORE)
+
+flake8:
+	@echo "Running flake8"
+	@flake8 .

Makefile

@@ -21,6 +21,7 @@ preview of the theme.
 Other Sites Using the PyAnsys theme:
 
 - `PyMAPDL <https://mapdldocs.pyansys.com/>`__
+- `PyAEDT <https://aedtdocs.pyansys.com/>`__
 - `DPF-Core <https://dpfdocs.pyansys.com/>`__
 - `DPF-Post <https://postdocs.pyansys.com/>`__
 - `Legacy PyMAPDL Reader <https://readerdocs.pyansys.com/>`__

README.rst

@@ -19,6 +19,7 @@ help:
 	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
 
 
-# customized clean due to examples gallery
+# customized clean due to api examples
 clean:
 	rm -rf build
+	find . -type d -name "_autosummary" -exec rm -rf {} +

doc/Makefile

@@ -0,0 +1 @@
+## Contains static files for the documentation build

doc/source/_static/README.md

@@ -0,0 +1 @@
+## Contains templates for the documentation build