Skip to content

Commit

Permalink
Fix documentation generation
Browse files Browse the repository at this point in the history
* Formatting on Documenter.yml was incorrect
* docs/Package.toml was missing
* make.jl was out of date
  • Loading branch information
kmsquire committed Jan 30, 2021
1 parent 2f4acde commit 9b9d4ba
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 13 deletions.
16 changes: 8 additions & 8 deletions .github/workflows/Documenter.yml
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
name: Documenter
on:
push:
push:
branches: [master]
tags: [v*]
pull_request:
pull_request:

jobs:
Documenter:
Documenter:
name: Documentation
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-docdeploy@latest
- uses: actions/checkout@v2
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-docdeploy@latest
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
2 changes: 2 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
10 changes: 5 additions & 5 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@ using OrderedCollections


makedocs(
format = :html,
format = Documenter.HTML(
prettyurls = get(ENV, "CI", nothing) == "true"
),
sitename = "OrderedCollections.jl",
pages = [
"index.md",
Expand All @@ -13,9 +15,7 @@ makedocs(

deploydocs(
repo = "github.com/JuliaCollections/OrderedCollections.jl.git",
julia = "0.7",
latest = "master",
target = "build",
deps = nothing, # we use the `format = :html`, without `mkdocs`
make = nothing, # we use the `format = :html`, without `mkdocs`
deps = nothing,
make = nothing,
)

0 comments on commit 9b9d4ba

Please sign in to comment.