Documenter (#85)

* 0.7.5

* documenter

* Apply suggestions from code review

Co-authored-by: David Widmann <[email protected]>

* docs wip

* Apply suggestions from code review

Co-authored-by: David Widmann <[email protected]>

* DocCleapup

---------

Co-authored-by: David Widmann <[email protected]>

Author: JaimeRZP

.github/workflows/DocCleanup.yml

@@ -0,0 +1,28 @@
+name: Doc Preview Cleanup
+
+on:
+  pull_request:
+    types: [closed]
+
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v3
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "[email protected]"
+              git rm -rf "previews/PR$PRNUM"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+            fi
+        env:
+            PRNUM: ${{ github.event.number }}

.github/workflows/documentation.yml

@@ -0,0 +1,30 @@
+name: Documentation
+
+on:
+  push:
+    branches:
+      - master
+    tags: '*'
+  pull_request:
+
+jobs:
+  build:
+    permissions:
+      contents: write
+      statuses: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: julia-actions/setup-julia@v1
+        with:
+          version: 1
+      - name: Install dependencies
+        run: julia --project=docs/ -e '
+              using Pkg; 
+              Pkg.develop(PackageSpec(path=pwd())); 
+              Pkg.instantiate()'
+      - name: Build and deploy
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: julia --project=docs/ docs/make.jl
+

docs/.gitignore

@@ -0,0 +1 @@
+/build/

docs/Project.toml

@@ -0,0 +1,2 @@
+[deps]
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"

docs/make.jl

@@ -0,0 +1,13 @@
+using Pkg
+
+using Documenter
+using AdvancedMH
+
+# cp(joinpath(@__DIR__, "../README.md"), joinpath(@__DIR__, "src/index.md"))
+
+makedocs(sitename = "AdvancedMH", format = Documenter.HTML(), modules = [AdvancedMH])
+
+deploydocs(
+    repo = "github.com/TuringLang/AdvancedMH.jl.git",
+    push_preview = true, # allow PR to deploy
+)

docs/src/api.md

@@ -0,0 +1,15 @@
+# AdvancedMH.jl
+
+Documentation for AdvancedMH.jl
+
+
+## Structs
+```@docs
+MetropolisHastings
+```
+
+## Functions
+```@docs
+StaticMH
+RWMH
+```

docs/src/index.md

@@ -0,0 +1 @@
+../../README.md