Merge pull request #101 from 2e0byo/master

Deploy docs to github pages (without storing in repository).
nlfiedler · Mar 8, 2023 · 1cfbc83 · 1cfbc83
2 parents e44ec07 + cb5e450
commit 1cfbc83
Show file tree

Hide file tree

Showing 3 changed files with 66 additions and 0 deletions.
diff --git a/.github/static-files/index.html b/.github/static-files/index.html
@@ -0,0 +1,8 @@
+<html>
+  <head>
+    <meta http-equiv="Refresh" content="0; url='magick_rust/index.html'" />
+  </head>
+  <body>
+    <p>Please <a href="magick_rust/index.html">click here</a> if you are not automatically redirected.</p>
+  </body>
+</html>
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -0,0 +1,54 @@
+name: Build and deploy docs
+
+on:
+  push:
+    branches:
+      - master
+    workflow_dispatch:
+
+permissions:
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: deps
+        run: |
+          # sudo apt update && sudo apt install -y libmagickwand-dev
+          curl https://imagemagick.org/archive/ImageMagick.tar.gz | tar xz
+          cd ImageMagick-7.1*
+          ./configure --with-magick-plus-plus=no --with-perl=no 
+          make -j
+          sudo make install
+      - uses: Swatinem/rust-cache@v2
+      - name: build docs
+        run: |
+          cargo doc --no-deps
+          cp .github/static-files/index.html target/doc/
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ./target/doc
+
+  deploy:
+    needs: build
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - name: Setup Pages
+        uses: actions/configure-pages@v3
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1
+
+
+
diff --git a/README.md b/README.md
@@ -2,6 +2,10 @@
 
 A somewhat safe Rust interface to the [ImageMagick](http://www.imagemagick.org/) system, in particular, the MagickWand library. Many of the functions in the MagickWand API are still missing, but over time more will be added. Pull requests are welcome.
 
+## Documentation
+
+Documentation for upstream is hosted on [github pages](https://nlfiedler.github.io/magick-rust).  To build locally run `cargo doc`.
+
 ## Dependencies
 
 * Rust stable