Merge pull request #5 from sandialabs/docs

Add github automated workflows and update documenter.jl docs to run

.github/workflows/CI.yaml

@@ -0,0 +1,35 @@
+name: CI
+on:
+  push:
+    branches:
+      - master
+    tags: '*'
+  pull_request:
+concurrency:
+  # Skip intermediate builds: always.
+  # Cancel intermediate builds: only if it is a pull request build.
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: ${{ startsWith(github.ref, 'refs/pull/') }}
+jobs:
+  test:
+    name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        version:
+          - '1.6'
+          - '1'
+        os:
+          - ubuntu-latest
+        arch:
+          - x64
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: julia-actions/cache@v1
+      - uses: julia-actions/julia-buildpkg@v1
+      - uses: julia-actions/julia-runtest@v1

.github/workflows/CompatHelper.yml

@@ -0,0 +1,16 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: '00 00 * * *'
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'

.github/workflows/Documentation.yml

@@ -0,0 +1,28 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: '1'
+      - name: Install dependencies
+        env:
+          PYTHON: ""
+        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
+        run: julia --project=docs/ docs/make.jl

.github/workflows/TagBot.yml

@@ -0,0 +1,15 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}

docs/make.jl

@@ -26,4 +26,8 @@ makedocs(;
     ],
     sitename = "OWENSFEA.jl",
     authors = "Kevin R. Moore <kevmoor@sandia.gov>",
+)
+
+deploydocs(
+    repo = "github.com/sandialabs/OWENSFEA.jl.git",
 )

docs/src/reference/reference.md

@@ -1,91 +1,14 @@
-# Library
-
-```@contents
-Pages = ["library.md"]
-Depth = 3
+```@meta
+CurrentModule = OWENSFEA
 ```
 
-## Public API
-
-### OWENSFEA Functions and Docstrings
+## Index
 
-```@docs
-OWENSFEA.FEAModel
-OWENSFEA.mapVector 
-OWENSFEA.adaptiveLoadStepping 
-OWENSFEA.calculateVec1! 
-OWENSFEA.applyConstraintsVec 
-OWENSFEA.structuralDynamicsTransientROM 
-OWENSFEA.interpolateVal 
-OWENSFEA.El
-OWENSFEA.determineActiveDofsFromSlaveNode 
-OWENSFEA.DispData
-OWENSFEA.calculateElementMass 
-OWENSFEA.calculateROM 
-OWENSFEA.calculateStructureMassProps 
-OWENSFEA.extractFreqDamp 
-OWENSFEA.BC_struct
-OWENSFEA.ModalOutput 
-OWENSFEA.ConcMassAssociatedWithElement 
-OWENSFEA.constructReducedDispVecFromEigVec 
-OWENSFEA.NodalTerms
-OWENSFEA.DispOut
-OWENSFEA.getNodeMaps 
-OWENSFEA.staticAnalysis 
-OWENSFEA.getGP 
-OWENSFEA.ElInput
-OWENSFEA.assemblyMatrixOnly 
-OWENSFEA.Ort
-OWENSFEA.mapMatrixNonSym 
-OWENSFEA.reducedOrderModel 
-OWENSFEA.setInitialConditions 
-OWENSFEA.TimeInt
-OWENSFEA.ElStrain
-OWENSFEA.calculateTimoshenkoElementNLSS 
-OWENSFEA.calculateLoadVecFromDistForce 
-OWENSFEA.calculateReactionForceAtNode 
-OWENSFEA.ConcNDL1D
-OWENSFEA.calculateShapeFunctions 
-OWENSFEA.calculateReducedDOFVector 
-OWENSFEA.assembly! 
-OWENSFEA.applyBC 
-OWENSFEA.constructReducedDispVectorMap 
-OWENSFEA.findElementsAssociatedWithNodeNumber 
-OWENSFEA.calculateTimoshenkoElementNL 
-OWENSFEA.applyBCModal 
-OWENSFEA.createJointTransform 
-OWENSFEA.SectionPropsArray
-OWENSFEA.modal 
-OWENSFEA.ElStorage
-OWENSFEA.calcUnorm 
-OWENSFEA.linearAnalysisModal 
-OWENSFEA.applyConstraints 
-OWENSFEA.calculateStrainForElements 
-OWENSFEA.calculateBCMap 
-OWENSFEA.timeIntegrateSubSystemEff 
-OWENSFEA.ROM
-OWENSFEA.structuralDynamicsTransient 
-OWENSFEA.initialElementCalculations 
-OWENSFEA.calculateROMGyric 
-OWENSFEA.ConcNDL2D
-OWENSFEA.calculateLambda 
-OWENSFEA.calculateTimoshenkoElementStrain 
-OWENSFEA.getElementConcTerms! 
-OWENSFEA.calculateElement1! 
-OWENSFEA.mapMatrixNonSym2 
-OWENSFEA.makeBCdata 
-OWENSFEA.createTda 
-OWENSFEA.NlParams
-OWENSFEA.Mesh
-OWENSFEA.updateLoadStep 
-OWENSFEA.extractdaInfo 
-OWENSFEA.applyConcentratedTerms 
-OWENSFEA.ElOutput
-OWENSFEA.calculateTimoshenkoElementInitialRun 
+```@index
 ```
 
+## Types and functions
 
-## Index
-
-```@index
+```@autodocs
+Modules = [OWENSFEA]
 ```

src/utilities.jl

@@ -1750,7 +1750,7 @@ Internal, applies 6x6 concentrated nodal terms from user input.
 
 #Input
 * `filename`:   string containing nodal terms filename
-* `data`:       Nx5 or Nx4 array matching general [1 "M6" 1 1 0.0] or diagonal only [1 "M" 1 0.0] (node, Type, dof, value) where type is M,C,K, or F
+* `data`:       Nx5 or Nx4 array matching general [1 "M6" 1 1 0.0] or diagonal only [1 "M" 1 0.0] aligning with node, Type, dof, value, where type is M,C,K, or F
 
 #Output
 * `nodalTerms::NodalTerms`: see ?NodalTerms object containing concentrated nodal data