Skip to content

Commit d99b12b

Browse files
committed
DROP ME: simplify docs build
1 parent 1819f87 commit d99b12b

File tree

10 files changed

+29
-639
lines changed

10 files changed

+29
-639
lines changed

.github/workflows/Documentation.yml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ concurrency:
2525
# git-push to the same branch, so we want to avoid clashes. NOTE: this is
2626
# different from the concurrency group below, which is to cancel successive
2727
# jobs from within the PR.
28-
group: docs-pushing
28+
group: docs-pushing-1
2929

3030
jobs:
3131
build:
@@ -45,7 +45,7 @@ jobs:
4545
- uses: actions/checkout@v5
4646
- uses: julia-actions/setup-julia@v2
4747
with:
48-
version: "min"
48+
version: "1.12"
4949
- uses: julia-actions/cache@v2
5050
id: julia-cache
5151
- uses: actions/create-github-app-token@v2
@@ -58,6 +58,8 @@ jobs:
5858
env:
5959
GITHUB_TOKEN: ${{ steps.generate_token.outputs.token }}
6060
DOCUMENTER_KEY: ${{ secrets.BREEZEDOCUMENTATION_DOCUMENTER_KEY }}
61+
JULIA_DEBUG: Documenter
62+
ACTIONS_RUNNER_DEBUG: true
6163
- name: Save Julia depot cache on cancel or failure
6264
id: julia-cache-save
6365
if: cancelled() || failure()

docs/Project.toml

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
[deps]
2-
CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
32
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
4-
DocumenterCitations = "daee34ce-89f3-4625-b898-19384cb65244"
53
Oceananigans = "9e8cae18-63c1-5223-a75c-80ca9d6e9a09"
64

75
[compat]
8-
CairoMakie = "0.13, 0.14"
96
Documenter = "1"
10-
DocumenterCitations = "1.4"
7+
8+
[sources]
9+
Documenter = {url = "https://github.com/giordano/documenter.jl", rev = "mg/post-github-status-deploydoc"}

docs/make.jl

Lines changed: 20 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,31 @@
11
using Breeze
22
using Documenter
3-
using DocumenterCitations
3+
# using DocumenterCitations
44

5-
using CairoMakie
6-
CairoMakie.activate!(type = "svg")
7-
set_theme!(Theme(linewidth = 3))
5+
# using CairoMakie
6+
# CairoMakie.activate!(type = "svg")
7+
# set_theme!(Theme(linewidth = 3))
88

9-
DocMeta.setdocmeta!(Breeze, :DocTestSetup, :(using Breeze); recursive=true)
9+
# DocMeta.setdocmeta!(Breeze, :DocTestSetup, :(using Breeze); recursive=true)
1010

11-
bib_filepath = joinpath(dirname(@__FILE__), "src", "breeze.bib")
12-
bib = CitationBibliography(bib_filepath, style=:authoryear)
11+
# bib_filepath = joinpath(dirname(@__FILE__), "src", "breeze.bib")
12+
# bib = CitationBibliography(bib_filepath, style=:authoryear)
1313

14-
makedocs(sitename="Breeze",
15-
plugins = [bib],
14+
makedocs(
15+
;
16+
doctest = false,
17+
warnonly = true,
18+
sitename="Breeze",
19+
# plugins = [bib],
1620
pages=[
1721
"Home" => "index.md",
18-
"Thermodynamics" => "thermodynamics.md",
19-
"Microphysics" => Any[
20-
"Overview" => "microphysics/microphysics_overview.md",
21-
"Warm phase saturation adjustment" => "microphysics/saturation_adjustment.md",
22-
],
23-
"References" => "references.md",
24-
"API" => "api.md",
22+
# "Thermodynamics" => "thermodynamics.md",
23+
# "Microphysics" => Any[
24+
# "Overview" => "microphysics/microphysics_overview.md",
25+
# "Warm phase saturation adjustment" => "microphysics/saturation_adjustment.md",
26+
# ],
27+
# "References" => "references.md",
28+
# "API" => "api.md",
2529
]
2630
)
2731

docs/src/api.md

Lines changed: 0 additions & 57 deletions
This file was deleted.

docs/src/breeze.bib

Lines changed: 0 additions & 30 deletions
This file was deleted.

docs/src/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Breeze provides two ways to simulate moist atmospheres:
1111

1212
* A [`MoistAirBuoyancy`](@ref) that can be used with [Oceananigans](https://clima.github.io/OceananigansDocumentation/stable/)' [`NonhydrostaticModel`](https://clima.github.io/OceananigansDocumentation/stable/appendix/library/#Oceananigans.Models.NonhydrostaticModels.NonhydrostaticModel-Tuple{}) to simulate atmospheric flows with the Boussinesq approximation.
1313

14-
* A prototype [`AtmosphereModel`](@ref Breeze.AtmosphereModels.AtmosphereModel) that uses the anelastic approximation following [Pauluis2008](@citet).
14+
* A prototype [`AtmosphereModel`](@ref Breeze.AtmosphereModels.AtmosphereModel) that uses the anelastic approximation following Pauluis2008.
1515

1616
## Installation
1717

@@ -26,7 +26,7 @@ Pkg.add("https://github.com/NumericalEarth/Breeze.jl.git")
2626

2727
A basic free convection simulation:
2828

29-
```@example intro
29+
```julia
3030
using Oceananigans
3131
using Oceananigans.Units
3232
using CairoMakie

docs/src/microphysics/microphysics_overview.md

Lines changed: 0 additions & 8 deletions
This file was deleted.

docs/src/microphysics/saturation_adjustment.md

Lines changed: 0 additions & 129 deletions
This file was deleted.

docs/src/references.md

Lines changed: 0 additions & 4 deletions
This file was deleted.

0 commit comments

Comments
 (0)