Docs

.github/workflows/build_docs.yaml

@@ -0,0 +1,31 @@
+name: Build and deploy documentation
+on:
+  push:
+    branches:
+      - master
+jobs:
+  build-docs:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ['3.10']
+    steps:
+      - uses: actions/checkout@v3
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v3
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y pandoc
+          python -m pip install -e .[development]
+      - name: Build docs
+        run: cd doc && make html
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./doc/build/html

.github/workflows/docs_check.yaml

@@ -0,0 +1,32 @@
+name: Check for Sphinx Warnings
+
+on:
+  pull_request:
+    paths:
+      - "doc/**"
+      - "**/*.rst"
+      - ".github/workflows/docs_check.yaml"
+      - "setup.py"
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Check out the repository
+      uses: actions/checkout@v3
+
+    - name: Set up Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: '3.x'
+
+    - name: Install dependencies
+      run: |
+          sudo apt-get update
+          sudo apt-get install -y pandoc
+          python -m pip install -e .[development]
+
+    - name: Check for Sphinx warnings
+      run: |
+        sphinx-build -M html ./doc/source ./doc/_build --fail-on-warning

.github/workflows/format_check.yml

@@ -0,0 +1,11 @@
+name: Ruff format
+on: [push, pull_request]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+        with:
+          args: 'format --check'
+          version: 0.7.0

.github/workflows/lint.yml

@@ -0,0 +1,10 @@
+name: Ruff check
+on: [push, pull_request]
+jobs:
+  ruff:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: chartboost/ruff-action@v1
+        with:
+          version: 0.7.0

.github/workflows/spell_check.yml

@@ -0,0 +1,15 @@
+name: Spell Check
+
+on: [push, pull_request]
+
+jobs:
+  spell-check:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Run codespell
+      uses: codespell-project/actions-codespell@v2
+

.github/workflows/tests.yml

@@ -10,7 +10,7 @@ jobs:
     strategy:
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
-        python-version: ['3.8', '3.9', '3.10']
+        python-version: ['3.9', '3.10', '3.11','3.12']
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}

.gitignore

@@ -38,3 +38,7 @@ __pycache__
 flycheck*.py
 /notes/
 /.ropeproject/
+
+/doc_src/
+/doc/build/
+/doc/source/api_reference/_autosummary

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "pelicun/resources/DamageAndLossModelLibrary"]
+	path = pelicun/resources/DamageAndLossModelLibrary
+	url = https://github.com/NHERI-SimCenter/DamageAndLossModelLibrary