Merge pull request #354 from gwbres/fix-ut1-docs

Fix UT1 feature documentation
nyx-space · Feb 8, 2025 · 41361bb · 41361bb
2 parents d124c90 + b4f4d52
commit 41361bb
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 28 deletions.
diff --git a/.github/workflows/python.yml b/.github/workflows/python.yml
@@ -32,9 +32,6 @@ jobs:
         with:
           python-version: ">=3.9"
 
-      # - name: Fix openssl regression
-      #   run: cargo update openssl-src --precise 300.3.1+3.3.1
-
       - name: Build wheels
         uses: PyO3/maturin-action@v1
         with:
@@ -56,9 +53,9 @@ jobs:
                 apt update -y && apt-get install -y libssl-dev openssl pkg-config
             fi
       - name: Upload wheels
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: wheels
+          name: wheels-linux-${{ matrix.target }}
           path: dist
       - name: pytest
         if: ${{ startsWith(matrix.target, 'x86_64') }}
@@ -69,22 +66,6 @@ jobs:
           pip install hifitime --find-links dist --force-reinstall --no-index -vv
           pip install pytest
           pytest
-      # - name: pytest
-      #   if: ${{ !startsWith(matrix.target, 'x86') && matrix.target != 'ppc64' }}
-      #   uses: uraimo/run-on-arch-action@v2.5.0
-      #   with:
-      #     arch: ${{ matrix.target }}
-      #     distro: ubuntu22.04
-      #     githubToken: ${{ github.token }}
-      #     install: |
-      #       apt-get update
-      #       apt-get install -y --no-install-recommends python3 python3-pip
-      #       pip3 install -U pip pytest
-      #     run: |
-      #       set -e
-      #       ls dist
-      #       pip3 install hifitime --find-links dist --force-reinstall --no-index -vv
-      #       pytest
 
   windows:
     runs-on: windows-latest
@@ -104,9 +85,9 @@ jobs:
           args: --release --out dist --find-interpreter -F python
           sccache: 'true'
       - name: Upload wheels
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
-          name: wheels
+          name: wheels-windows-${{ matrix.target }}
           path: dist
       - name: pytest
         if: ${{ !startsWith(matrix.target, 'aarch64') }}
@@ -136,7 +117,7 @@ jobs:
           sccache: 'true'
 
       - name: Upload wheels
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: wheels-macos-13
           path: dist
@@ -195,7 +176,7 @@ jobs:
           command: sdist
           args: --out dist
       - name: Upload sdist
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: wheels
           path: dist
@@ -206,9 +187,8 @@ jobs:
     if: github.ref_type == 'tag'
     needs: [linux, windows, macos-13, macos-14, sdist]
     steps:
-      - uses: actions/download-artifact@v3
-        with:
-          name: wheels
+      - uses: actions/download-artifact@v4
+
       - name: Publish to PyPI
         uses: PyO3/maturin-action@v1
         env:

diff --git a/Cargo.toml b/Cargo.toml
@@ -17,6 +17,10 @@ edition = "2021"
 crate-type = ["cdylib", "rlib"]
 name = "hifitime"
 
+[package.metadata.docs.rs]
+all-features = true
+rustdoc-args = ["--cfg", "docrs", "--generate-link-to-definition"]
+
 [dependencies]
 serde = { version = "1.0.155", optional = true }
 serde_derive = { version = "1.0.155", optional = true }