add breadcrumb and pre-commit (#51)

* push always

* initial pre-commit add

* add pre-commit fully

* Commit the actual fix.

* Fix typo in the test_practices to validate pre-commit.

* Update .pre-commit-config.yaml

Co-authored-by: Maxime Rey <[email protected]>

* add dependabot

* add breadcrumbs

* move wsl guide out

* fully implement pre-commit

* use 3.10 properly

Co-authored-by: Maxime Rey <[email protected]>
Co-authored-by: Maxime Rey <[email protected]>

Author: akaszynski

.flake8

@@ -0,0 +1,7 @@
+[flake8]
+exclude = build, doc/source/conf.py
+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/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: "pip" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    insecure-external-code-execution: allow
+    schedule:
+      interval: "daily"
+    labels:
+      - "maintenance"
+      - "dependencies"

.github/workflows/ci-build.yml

@@ -9,6 +9,24 @@ on:
       - main
 
 jobs:
+  pre-commit:
+    name: Pre-commit checks
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Setup Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: '3.10'
+      - name: Install pre-commit requirements
+        run: |
+          pip install pre-commit~=2.16.0
+
+      - name: Run pre-commit
+        run: |
+          pre-commit run --all-files || ( git status --short ; git diff ; exit 1 )
+
   docs_build:
     runs-on: ubuntu-latest
 
@@ -26,6 +44,16 @@ jobs:
           make -C doc html SPHINXOPTS="-W"
           touch doc/build/html/.nojekyll
           echo "dev.docs.pyansys.com" > doc/build/html/CNAME
+
+      - name: Deploy to gh-pages on main
+        if: github.ref == 'refs/heads/main'
+        uses: JamesIves/[email protected]
+        with:
+          token: ${{ secrets.github_token }}
+          branch: gh-pages
+          folder: docs/build/html
+          clean: true
+          single-commit: true
 
       - name: Build PDF Documentation
         run: |
@@ -64,17 +92,9 @@ jobs:
       - name: Display structure of downloaded files
         run: ls -R
 
-      - name: Deploy to gh-pages
-        uses: JamesIves/[email protected]
-        with:
-          token: ${{ secrets.github_token }}
-          branch: gh-pages
-          folder: HTML-Documentation
-          clean: true
-          single-commit: true
-
       - name: Release
         uses: softprops/action-gh-release@v1
         with:
+          generate_release_notes: true
           files: |
             ./*PDF*/*.pdf

.github/workflows/style.yml

@@ -0,0 +1,22 @@
+repos:
+- repo: https://github.com/psf/black
+  rev: 21.12b0
+  hooks:
+  - id: black
+    exclude: "^({{cookiecutter.project_slug}}/)"
+- repo: https://github.com/asottile/reorder_python_imports
+  rev: v2.6.0
+  hooks:
+  - id: reorder-python-imports
+    args: ["--py37-plus"]
+    exclude: "^({{cookiecutter.project_slug}}/)"
+- repo: https://gitlab.com/PyCQA/flake8
+  rev: 3.9.2
+  hooks:
+  - id: flake8
+    exclude: "^({{cookiecutter.project_slug}}/)"
+- repo: https://github.com/codespell-project/codespell
+  rev: v2.1.0
+  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]

.pre-commit-config.yaml

@@ -1,30 +1,39 @@
+"""Sphinx documentation configuration file for the pyansys developer's guide."""
 from datetime import datetime
 
-from pyansys_sphinx_theme import __version__, pyansys_logo_black
+from pyansys_sphinx_theme import __version__
+from pyansys_sphinx_theme import pyansys_logo_black
 
 # Project information
-project = 'PyAnsys Developers Guide'
+project = "PyAnsys Developer's Guide"
 copyright = f"(c) {datetime.now().year} ANSYS, Inc. All rights reserved"
 author = "Ansys Inc."
-release = version = '0.2.dev0'
+release = version = "0.2.dev0"
 
 html_logo = pyansys_logo_black
-html_theme = 'pyansys_sphinx_theme'
+html_theme = "pyansys_sphinx_theme"
 
 html_theme_options = {
-    "github_url": "https://github.com/pyansys/about",
-    "show_prev_next": False
+    "github_url": "https://github.com/pyansys/dev-guide",
+    "show_prev_next": False,
+    "show_breadcrumbs": True,
+    "additional_breadcrumbs": [
+        ("PyAnsys", "https://docs.pyansys.com/"),
+    ],
 }
 
+# necessary for proper breadcrumb title
+html_short_title = html_title = project
+
 # Sphinx extensions
 extensions = [
     "sphinx_copybutton",
-    'sphinx_toolbox.collapse',
-    'sphinx.ext.autodoc',
-    'sphinx.ext.autosummary',
-    'sphinx.ext.intersphinx',
-    'sphinx.ext.napoleon',
-    'sphinx.ext.todo',
+    "sphinx_toolbox.collapse",
+    "sphinx.ext.autodoc",
+    "sphinx.ext.autosummary",
+    "sphinx.ext.intersphinx",
+    "sphinx.ext.napoleon",
+    "sphinx.ext.todo",
 ]
 
 # Intersphinx mapping
@@ -38,22 +47,24 @@
 }
 
 # The suffix(es) of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 latex_elements = {}
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title,
 #  author, documentclass [howto, manual, or own class]).
 latex_documents = [
-    (master_doc,
-     f'pyansys_dev_guide_v{version}.tex',
-     "PyAnsys Developer's Guide",
-     author,
-     'manual'),
+    (
+        master_doc,
+        f"pyansys_dev_guide_v{version}.tex",
+        "PyAnsys Developer's Guide",
+        author,
+        "manual",
+    ),
 ]
 
 

doc/source/conf.py

@@ -1,14 +1,14 @@
 def func(arg1, arg2):
     """Summary line <should be only one line>.
 
-    Extended description of the function. The extended description, 
-    which can span multiple lines, should provide a general overview 
+    Extended description of the function. The extended description,
+    which can span multiple lines, should provide a general overview
     of the function.
 
     .. warning::
        Use the ``.. warning::`` directive within the docstring for any
-       warnings that need to be explicitly stated. For example, you 
-       want to include a warning for a method that is to be deprecated 
+       warnings that need to be explicitly stated. For example, you
+       want to include a warning for a method that is to be deprecated
        in the next release.
 
     Parameters