Skip to content

Commit

Permalink
try docs again
Browse files Browse the repository at this point in the history
  • Loading branch information
tduretz committed Aug 23, 2023
1 parent 8f51fdf commit ce056a5
Show file tree
Hide file tree
Showing 5 changed files with 112 additions and 38 deletions.
24 changes: 0 additions & 24 deletions .github/workflows/Documentation.yml

This file was deleted.

62 changes: 62 additions & 0 deletions .github/workflows/blank.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
name: CI

on:
push:
branches:
- main
tags: '*'
pull_request:

jobs:
run_tests:
name: Julia ${{ matrix.version }} - ${{ matrix.os }} - ${{ matrix.arch }} - ${{ github.event_name }}
runs-on: ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
version:
- '1.6'
- '1.7'
- '1.8'
- 'nightly'
os:
- ubuntu-latest
- macOS-latest
- windows-latest
arch:
- x64
steps:
- uses: actions/checkout@v3
- uses: julia-actions/setup-julia@v1
with:
version: ${{ matrix.version }}
arch: ${{ matrix.arch }}
- uses: actions/cache@v3
env:
cache-name: cache-artifacts
with:
path: ~/.julia/artifacts
key: ${{ runner.os }}-test-${{ env.cache-name }}-${{ hashFiles('**/Project.toml') }}
restore-keys: |
${{ runner.os }}-test-${{ env.cache-name }}-
${{ runner.os }}-test-
${{ runner.os }}-
- uses: julia-actions/julia-buildpkg@latest
- uses: julia-actions/julia-runtest@latest
build_docs:
runs-on: ubuntu-20.04
steps:
- uses: actions/checkout@v3
- uses: julia-actions/setup-julia@latest
with:
version: '1.6'
- name: Install dependencies 1
run: sudo apt-get update && sudo apt-get install -y xorg-dev mesa-utils xvfb libgl1 freeglut3-dev libxrandr-dev libxinerama-dev libxcursor-dev libxi-dev libxext-dev
- name: Install dependencies 2
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # For authentication with SSH deploy key
run: DISPLAY=:0 xvfb-run -s '-screen 0 1024x768x24'
julia --project=docs/ docs/make.jl
5 changes: 3 additions & 2 deletions docs/.gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,3 @@
build/
site/
Manifest.toml
.vscode
build/
7 changes: 7 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
name = "docs"
uuid = "62e1ee44-cd95-4c49-9bc9-2700b14f8531"
authors = ["tduretz <[email protected]>"]
version = "0.1.0"

[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
52 changes: 40 additions & 12 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,12 +1,40 @@
push!(LOAD_PATH,"../src/")
using SeismicQ
using Documenter
makedocs(
sitename = "SeismicQ.jl",
modules = [SeismicQ],
pages=[
"Home" => "index.md"
])
deploydocs(;
repo="github.com/tduretz/SeismicQ.jl",
)
using Documenter, SeismicQ
push!(LOAD_PATH, "../src/")

@info "Making documentation..."
makedocs(;
sitename="SeismicQ.jl",
authors="Cleedi Team",
modules=[SeismicQ],
format=Documenter.HTML(; prettyurls=get(ENV, "CI", nothing) == "true"), # easier local build
pages=[
"Home" => "index.md",
# "User Guide" => Any[
# "GeoUnit" => "man/geounit.md",
# "Nondimensionalization" => "man/nondimensionalize.md",
# "Material Parameters" => "man/materialparameters.md",
# "Density" => "man/density.md",
# "Creep laws" => "man/creeplaws.md",
# "Custom rheology" => "man/customrheology.md",
# "Elasticity" => "man/elasticity.md",
# "Plasticity" => "man/plasticity.md",
# "Heat Capacity" => "man/heatcapacity.md",
# "Conductivity" => "man/conductivity.md",
# "Latent heat" => "man/latentheat.md",
# "Radioactive heat" => "man/radioactiveheating.md",
# "Shear heating" => "man/shearheating.md",
# "Gravity" => "man/gravity.md",
# "Partial Melting" => "man/melting.md",
# "TAS classification" => "man/TASclassification.md",
# "Zircon Ages" => "man/zirconages.md",
# "Phase Diagrams" => "man/phasediagrams.md",
# "Seismic Velocity" => "man/seismicvelocity.md",
# "1D Strength Envelope" => "man/strengthenvelope.md"
# ],
# "Plotting" => "man/plotting.md",
# "List of functions" => "man/listfunctions.md",
# "Contributing" => "man/contributing.md",
],
)

deploydocs(; repo="github.com/tduretz/SeismicQ.jl.git", devbranch="main")

0 comments on commit ce056a5

Please sign in to comment.