From ecc1345338e089481b545e6492d9ef78d3e37c6e Mon Sep 17 00:00:00 2001
From: John Maximilian <2e0byo@gmail.com>
Date: Wed, 8 Mar 2023 10:44:51 +0000
Subject: [PATCH 1/3] ci: build docs.
---
.github/workflows/docs.yaml | 55 +++++++++++++++++++++++++++++++++++++
1 file changed, 55 insertions(+)
create mode 100644 .github/workflows/docs.yaml
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
new file mode 100644
index 0000000..a5e9d5b
--- /dev/null
+++ b/.github/workflows/docs.yaml
@@ -0,0 +1,55 @@
+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
+ - 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: Checkout
+ uses: actions/checkout@v3
+ - name: Setup Pages
+ uses: actions/configure-pages@v3
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v1
+
+
+
From 357995a15a0c33edfb5b42af900a168169600a1c Mon Sep 17 00:00:00 2001
From: John Maximilian <2e0byo@gmail.com>
Date: Wed, 8 Mar 2023 11:41:58 +0000
Subject: [PATCH 2/3] ci: add index.html.
Currently this is just a redirect, but we could build for different versions and
add a menu.
---
.github/static-files/index.html | 8 ++++++++
.github/workflows/docs.yaml | 3 +--
2 files changed, 9 insertions(+), 2 deletions(-)
create mode 100644 .github/static-files/index.html
diff --git a/.github/static-files/index.html b/.github/static-files/index.html
new file mode 100644
index 0000000..f175c8c
--- /dev/null
+++ b/.github/static-files/index.html
@@ -0,0 +1,8 @@
+
+
+
+
+
+ Please click here if you are not automatically redirected.
+
+
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
index a5e9d5b..93fe658 100644
--- a/.github/workflows/docs.yaml
+++ b/.github/workflows/docs.yaml
@@ -31,6 +31,7 @@ jobs:
- 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:
@@ -43,8 +44,6 @@ jobs:
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- - name: Checkout
- uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v3
- name: Deploy to GitHub Pages
From cb5e450cf31366a30444cf6415ae9bc79363dbb5 Mon Sep 17 00:00:00 2001
From: John Maximilian <2e0byo@gmail.com>
Date: Wed, 8 Mar 2023 11:57:19 +0000
Subject: [PATCH 3/3] docs: add note in readme.
This way it will be visible on crates.io and send people just browsing to the page.
---
README.md | 4 ++++
1 file changed, 4 insertions(+)
diff --git a/README.md b/README.md
index 16c28ae..26dcad5 100644
--- 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