Skip to content

Commit

Permalink
docs: update make docs (#88)
Browse files Browse the repository at this point in the history
* docs: update make docs

* chore: update docs ci
  • Loading branch information
ianna authored Mar 14, 2024
1 parent 5121bee commit 2a7ca09
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 47 deletions.
22 changes: 3 additions & 19 deletions .github/workflows/CI.yml
Original file line number Diff line number Diff line change
Expand Up @@ -68,26 +68,10 @@ jobs:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: julia-actions/setup-julia@latest
with:
version: '1'
- name: Cache artifacts
uses: actions/cache@v2
env:
cache-name: cache-artifacts
with:
path: ~/.julia/artifacts
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/docs/Project.toml') }}
restore-keys: |
${{ runner.os }}-test-${{ env.cache-name }}-
${{ runner.os }}-test-
${{ runner.os }}-
- uses: actions/checkout@v2
- uses: julia-actions/cache@v1
- uses: julia-actions/julia-buildpkg@latest
env:
PYTHON: 'Conda'
- uses: julia-actions/julia-docdeploy@latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
# GKSwstype: 'nul'
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
42 changes: 14 additions & 28 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,37 +1,23 @@
# Use
#
# DOCUMENTER_DEBUG=true julia --color=yes make.jl local [nonstrict] [fixdoctests]
#
# for local builds.
using Documenter, AwkwardArray

# Doctest setup
DocMeta.setdocmeta!(
AwkwardArray,
:DocTestSetup,
:(using AwkwardArray);
recursive=true,
)

makedocs(
sitename = "AwkwardArray",
modules = [AwkwardArray],
makedocs(;
modules=[AwkwardArray],
format = Documenter.HTML(
prettyurls = !("local" in ARGS),
canonical = "https://JuliaHEP.github.io/AwkwardArray.jl/stable/"
prettyurls = get(ENV, "CI", nothing) == "true",
assets=String[],
),
pages = [
"Home" => "index.md",
"API" => "api.md",
pages=[
"Introduction" => "index.md",
"Example Usage" => "exampleusage.md",
"APIs" => "api.md",
"LICENSE" => "LICENSE.md",
],
doctest = ("fixdoctests" in ARGS) ? :fix : true,
linkcheck = !("nonstrict" in ARGS),
repo="https://github.com/JuliaHEP/AwkwardArray.jl/blob/{commit}{path}#L{line}",
sitename="AwkwardArray.jl",
authors="Jim Pivarski, Jerry Ling, and contributors",
)

deploydocs(
repo = "github.com/JuliaHEP/AwkwardArray.jl",
forcepush = true,
push_preview = true,
deploydocs(;
repo="github.com/JuliaHEP/AwkwardArray.jl",
push_preview=true
)

0 comments on commit 2a7ca09

Please sign in to comment.