Skip to content

Commit

Permalink
Update documentation build script (#158)
Browse files Browse the repository at this point in the history
odow authored Sep 21, 2023
1 parent f6aca5f commit 2a2618d
Showing 4 changed files with 48 additions and 13 deletions.
24 changes: 24 additions & 0 deletions .github/workflows/doc_cleanup.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
name: Doc Preview Cleanup
on:
pull_request:
types: [closed]
jobs:
doc-preview-cleanup:
runs-on: ubuntu-latest
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 }}
6 changes: 3 additions & 3 deletions .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
@@ -11,14 +11,14 @@ jobs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: actions/checkout@v3
- uses: julia-actions/setup-julia@latest
with:
version: '1'
- name: Install Dependencies
run: julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
run: julia --project=docs --color=yes -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and Deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
run: julia --project=docs docs/make.jl
run: julia --project=docs --color=yes docs/make.jl
4 changes: 4 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,6 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
WaterModels = "7c60b362-08f4-5b14-8680-cd67a3e18348"

[compat]
Documenter = "1"
27 changes: 17 additions & 10 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,34 +1,41 @@
using Documenter, WaterModels
import Documenter
import WaterModels

makedocs(
modules = [WaterModels],
format = Documenter.HTML(analytics="UA-367975-10", mathengine=Documenter.MathJax(), prettyurls=false),
Documenter.makedocs(
sitename = "WaterModels",
authors = "Byron Tasseff and contributors",
format = Documenter.HTML(
analytics = "UA-367975-10",
mathengine = Documenter.MathJax(),
prettyurls = false,
),
pages = [
"Home" => "index.md",
"Manual" => [
"Getting Started" => "quickguide.md",
"Network Data Format" => "network-data.md",
"Result Data Format" => "result-data.md",
"Mathematical Models" => "math-model.md"
"Mathematical Models" => "math-model.md",
],
"Library" => [
"Network Formulations" => "formulations.md",
"Problem Specifications" => "specifications.md",
"Modeling Components" => [
"Objective" => "objective.md",
"Variables" => "variables.md",
"Constraints" => "constraints.md"
"Constraints" => "constraints.md",
],
"File I/O" => "parser.md"
"File I/O" => "parser.md",
],
"Developer" => "developer.md",
"Examples" => "examples.md"
"Examples" => "examples.md",
],
warnonly = true
clean = true,
modules = [WaterModels],
warnonly = true,
)

deploydocs(
Documenter.deploydocs(
repo = "github.com/lanl-ansi/WaterModels.jl.git",
push_preview = true,
)

0 comments on commit 2a2618d

Please sign in to comment.