Merge pull request #28 from radionets-project/fix-docs

Fix docs

Author: aknierim

.github/workflows/changelog.yml

@@ -0,0 +1,24 @@
+name: Changelog
+
+on:
+  pull_request:
+    # should also be re-run when changing labels
+    types: [opened, reopened, labeled, unlabeled, synchronize]
+
+env:
+  FRAGMENT_NAME: "docs/changes/${{ github.event.number }}.*.rst"
+
+jobs:
+  changelog:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - name: Check for news fragment
+        if: ${{ ! contains( github.event.pull_request.labels.*.name, 'no-changelog-needed')}}
+        uses: andstor/file-existence-action@v3
+        with:
+          files: ${{ env.FRAGMENT_NAME }}
+          fail: true

.github/workflows/ci.yml

@@ -20,11 +20,11 @@ jobs:
       matrix:
         include:
           - os: ubuntu-latest
-            python-version: "3.10"
+            python-version: "3.11"
             install-method: mamba
 
           - os: ubuntu-latest
-            python-version: "3.11"
+            python-version: "3.12"
             install-method: mamba
             extra-args: ["codecov"]
 
@@ -34,7 +34,7 @@ jobs:
         shell: bash -leo pipefail {0}
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           fetch-depth: 0
 
@@ -48,7 +48,7 @@ jobs:
 
       - name: mamba setup
         if: matrix.install-method == 'mamba' &&  contains(github.event.pull_request.labels.*.name, 'documentation-only') == false
-        uses: mamba-org/setup-micromamba@v1
+        uses: mamba-org/setup-micromamba@v2
         with:
           environment-file: environment.yml
           cache-downloads: true
@@ -58,7 +58,8 @@ jobs:
           PYTHON_VERSION: ${{ matrix.python-version }}
         run: |
           python --version
-          pip install --group dev -e ".[all]"
+          pip install --upgrade pip
+          pip install --group tests -e .
           pip freeze
           pip list
 
@@ -68,9 +69,43 @@ jobs:
 
       - name: Tests
         run: |
-          pytest -vv --cov --cov-branch --cov-report=xml
+          pytest -vv --cov --cov-report=xml --junitxml=junit.xml -o junit_family=legacy
 
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v5
         env:
           CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+      - name: Upload test results to Codecov
+        if: ${{ !cancelled() }}
+        uses: codecov/test-results-action@v1
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v5
+        with:
+          fetch-depth: 0
+
+      - uses: astral-sh/setup-uv@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install doc dependencies
+        run: |
+          sudo apt update --yes && sudo apt install --yes git
+          uv pip install --system . -U pip towncrier
+          uv pip install --system . --group docs -e .
+          git describe --tags
+
+      - name: Build docs
+        run: make -C docs html
+
+      - name: Produce Changelog
+        run: |
+          towncrier build --yes --version==0.0.0

.readthedocs.yml

@@ -11,10 +11,9 @@ build:
          - asdf plugin add uv
          - asdf install uv latest
          - asdf global uv latest
-         - mkdir $HOME/.casa/data
     install:
       - uv pip install --upgrade pip
-      - uv pip install --group docs .[casa]
+      - uv pip install --group docs
 
 sphinx:
   configuration: docs/conf.py

pyproject.toml

@@ -142,3 +142,40 @@ docstring-code-format = true
 
 [tool.ruff.lint.isort]
 known-first-party = ["pyvisgrid"]
+
+
+[tool.towncrier]
+    package = "pyvisgrid"
+    directory = "docs/changes"
+    filename = "CHANGES.rst"
+    template = "docs/changes/template.rst"
+    # let towncrier create proper links to the merged PR
+    issue_format = "`#{issue} <https://github.com/radionets-project/pyvisgrid/pull/{issue}>`__"
+
+    [tool.towncrier.fragment.feature]
+        name = "New Features"
+        showcontent = true
+
+    [tool.towncrier.fragment.bugfix]
+        name = "Bug Fixes"
+        showcontent = true
+
+    [tool.towncrier.fragment.api]
+        name = "API Changes"
+        showcontent = true
+
+    [tool.towncrier.fragment.datamodel]
+        name = "Data Model Changes"
+        showcontent = true
+
+    [tool.towncrier.fragment.optimization]
+        name = "Refactoring and Optimization"
+        showcontent = true
+
+    [tool.towncrier.fragment.maintenance]
+        name = "Maintenance"
+        showcontent = true
+
+    [[tool.towncrier.section]]
+        name = ""
+        path = ""