Merge pull request conjure-cp#238 from niklasdewally/fix/doc-gen

CI: fix docs

.github/workflows/docs-generate.yml → .github/workflows/docs.yml

@@ -1,4 +1,4 @@
-name: "Documentation (Generate)"
+name: "Documentation"
 
 on:
   push:
@@ -11,6 +11,8 @@ env:
   SCCACHE_GHA_ENABLED: "true"
   RUSTC_WRAPPER: "sccache"
 
+permissions:
+  contents: write
 
 jobs:
   coverage:
@@ -43,8 +45,10 @@ jobs:
           mkdir deploy
           cp -r target/doc/* deploy
 
-      - name: Archive code coverage results
-        uses: actions/upload-artifact@v3
+      - name: Deploy to Github Pages 
+        uses: JamesIves/github-pages-deploy-action@v4
         with:
-          name: docs-${{github.sha}}
-          path: deploy/**
+          folder: ./deploy
+          target-folder: "docs"
+          branch: gh-pages
+          commit-message: "Actions: Documentation for ${{ steps.sha.outputs.result }}"

doc/index.md

@@ -4,19 +4,22 @@
 
 Welcome to the documentation of Conjure Oxide.
 
-* [conjure_oxide - Main Documentation](conjure_oxide/index.html)
+* [conjure_oxide - Main Reference](conjure_oxide/index.html)
+* [Uniplate - Generic Traversals, Haskell style!](uniplate/index.html)
 
-## Solvers
+## Crates
 
 These crates contain Rust bindings for solvers:
 
 * [minion_rs](minion_rs/index.html)
 * [chuffed_rs](chuffed_rs/index.html)
 
+
 ## Developer Documentation
 
 The following are internal crates. Documentation is provided for developer
 reference:
 
 * [conjure_core](conjure_core/index.html)
 * [conjure_rules](conjure_rules/index.html)
+* [enum_compatability_macro](enum_compatability_macro/index.html)

tools/gen_docs.sh

@@ -26,5 +26,5 @@ TARGET_DIR=$(cargo metadata 2> /dev/null | jq -r .target_directory 2>/dev/null)
 cd "$PROJECT_ROOT"
 rm -rf "$TARGET_DIR/doc"
 
-RUSTDOCFLAGS="-Zunstable-options --markdown-no-toc --index-page ${PROJECT_ROOT}/doc/index.md" cargo +nightly doc --no-deps --all-features -p conjure_oxide -p conjure_core -p minion_rs -p chuffed_rs -p conjure_rules -p uniplate $@
+RUSTDOCFLAGS="-Zunstable-options --markdown-no-toc --index-page ${PROJECT_ROOT}/doc/index.md" cargo +nightly doc --no-deps --all-features -p conjure_oxide -p conjure_core -p minion_rs -p chuffed_rs -p conjure_rules -p uniplate -p enum_compatability_macro $@