Build and deploy docs to Github pages (#35)

* Added Github action for building and publishing docs

* Create index redirect page for docs

* Only deploy on master, fixed redirect

Author: davidcole1340

.github/workflows/docs.yml

@@ -0,0 +1,51 @@
+name: Deploy documentation
+on:
+  push:
+    branches:
+      - master
+
+jobs:
+  docs:
+    name: Build and Deploy
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        rust-toolchain:
+          - nightly
+        php:
+          - '8.0'
+        llvm:
+          - '11.0'
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v2
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+      - name: Setup Rust
+        uses: actions-rs/toolchain@v1
+        with:
+          toolchain: ${{ matrix.rust-toolchain }}
+      - name: Setup LLVM & Clang
+        uses: KyleMayes/install-llvm-action@v1
+        with:
+          version: ${{ matrix.llvm }}
+          directory: ${{ runner.temp }}/llvm-${{ matrix.llvm }}
+      - name: Build docs
+        uses: actions-rs/cargo@v1
+        env:
+          LIBCLANG_PATH: ${{ runner.temp }}/llvm-${{ matrix.llvm }}/lib
+        with:
+          command: doc
+          args: --release
+      - name: Create index redirect
+        run: |
+          echo '<meta http-equiv=refresh content=0;url=/ext-php-rs/ext_php_rs>' > target/doc/index.html
+      - name: Publish docs
+        uses: JamesIves/[email protected]
+        with:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          BRANCH: gh-pages
+          FOLDER: target/doc
+          CLEAN: true

README.md

@@ -4,6 +4,12 @@ Bindings for the Zend API to build PHP extensions natively in Rust. Inspired by
 
 [![PHP Discorders](https://discord.com/api/guilds/115233111977099271/widget.png?style=banner1)](https://discord.gg/dphp)
 
+## Documentation
+
+We are currently unable to deploy our documentation to `docs.rs` due to the crate requiring PHP 8.0, which is unavailable in the default Ubuntu repositories.
+Documentation can be viewed [here](https://davidcole1340.github.io/ext-php-rs/). It is generated from the latest `master` branch. Documentation will be moved to `docs.rs` when Ubuntu updates its repositories
+to PHP 8.0.
+
 ## Features
 
 This is not a set feature list, but these are the features on my roadmap. Create an issue if there's something you'd like to see!