Merge pull request #2 from mrbuche/main

pages workflow

Author: dprohe

.github/workflows/pages.yml

@@ -0,0 +1,41 @@
+name: pages
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+jobs:
+  build:
+    runs-on: ubuntu-22.04
+    steps:
+      - uses: actions/checkout@v2
+      - name: install package
+        run: pip install .[all]
+      - name: pylint badge
+        run: |
+          python -m pylint --disable=C0103 --output-format=text src/sdynpy | tee pylint.log || pylint-exit $?
+          PYLINT_SCORE=$(sed -n 's/^Your code has been rated at \([-0-9.]*\)\/.*/\1/p' pylint.log)
+          if (( $(echo "${PYLINT_SCORE} >= 8.0" | bc -l) )); then
+            COLOR=brightgreen
+          elif (( $(echo "${PYLINT_SCORE} >= 4.0" | bc -l) )); then
+            COLOR=yellow
+          elif (( $(echo "${PYLINT_SCORE} >= 2.0" | bc -l) )); then
+            COLOR=orange
+          else
+            COLOR=red
+          fi
+          curl "https://img.shields.io/badge/Pylint-${PYLINT_SCORE}-${COLOR}?logo=python&logoColor=FBE072" -o pylint.svg
+      - name: build docs
+        run: |
+          sudo apt-get install pandoc
+          sphinx-build -b html docs/source/ docs/build/html/
+          sed -i -e "s/ module</</g" docs/build/html/*.html
+          sed -i '/Built with/,/Docs<\/a>./d' docs/build/html/*.html
+          mv docs/build/html/ public/
+          mv pylint.svg public/
+      - name: deploy docs to gh-pages
+        if: github.event_name != 'pull_request'
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: public/

README.rst

@@ -2,6 +2,17 @@
 Structural Dynamics Python Libraries
 ####################################
 
+|build| |pylint|
+
 This repository houses SDynPy, a Python module built for doing structural dynamics analysis using Python.
 It contains core objects that define test geometry and data.  It contains readers and writers for common data formats.
-It also contains various structural dynamics and signal processing tools.
+It also contains various structural dynamics and signal processing tools.
+
+..
+    Badges ========================================================================
+
+.. |build| image:: https://img.shields.io/github/workflow/status/sandialabs/sdynpy/main?label=GitHub&logo=github
+    :target: https://github.com/sandialabs/sdynpy
+
+.. |pylint| image:: https://raw.githubusercontent.com/sandialabs/sdynpy/gh-pages/pylint.svg
+    :target: https://github.com/sandialabs/sdynpy

docs/source/_templates/footer.html

@@ -30,8 +30,10 @@ def get_version():
 
 
 project = 'SDynPy'
-copyright = '2022, Sandia National Laboratories'
 author = 'Daniel P. Rohe'
+copyright = '2022 National Technology & Engineering Solutions of Sandia, \
+    LLC (NTESS). Under the terms of Contract DE-NA0003525 with NTESS, \
+    the U.S. Government retains certain rights in this software'
 
 # The full version, including alpha/beta/rc tags
 release = get_version()

docs/source/conf.py

@@ -63,10 +63,10 @@ def get_ui_files(directory):
                  'sphinx', 'sphinx-rtd-theme', 'sphinxcontrib-bibtex',
                  'sphinx-copybutton'],
         'testing': ['pycodestyle', 'pylint', 'pytest', 'pytest-cov'],
-        'all': ['docutils<0.18,>=0.14', 'ipykernel', 'ipython',
-                'jinja2>=3.0', 'nbsphinx',
-                'pycodestyle', 'pylint', 'pytest', 'pytest-cov',
-                'sphinx', 'sphinx-rtd-theme', 'sphinxcontrib-bibtex']},
+        'all': ['docutils<0.18,>=0.14', 'ipykernel', 'ipython', 'jinja2>=3.0',
+                'nbsphinx', 'pycodestyle', 'pylint', 'pytest', 'pytest-cov',
+                'sphinx', 'sphinx-copybutton',
+                'sphinx-rtd-theme', 'sphinxcontrib-bibtex']},
     classifiers=['Natural Language :: English',
                  'Operating System :: Microsoft :: Windows :: Windows 10'
                  'Operating System :: MacOS :: MacOS X',