seoxi/magick-rust
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #101 from 2e0byo/master

Browse Source 
Deploy docs to github pages (without storing in repository).
This commit is contained in:
Nathan Fiedler
2023-03-08 10:32:59 -08:00
committed by GitHub
parent e44ec078a2 cb5e450cf3
commit 1cfbc83471
3 changed files with 66 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
.github/static-files/index.html vendored Normal file
View File

@ -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>

54
.github/workflows/docs.yaml vendored Normal file
View File

@ -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

4
README.md
View File

@ -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. 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 ## Dependencies
* Rust stable * Rust stable