Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions .github/workflows/Documentation.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,31 @@
name: Documentation

on:
push:
branches: master
tags: v*

pull_request:
branches: master

jobs:
build:
runs-on: ${{ matrix.os }}
strategy:
matrix:
julia-version: [1.4]
julia-arch: [x86]
os: [ubuntu-latest]
steps:
- uses: actions/[email protected]
- name: Setup julia
uses: julia-actions/setup-julia@latest
with:
version: ${{ matrix.julia-version }}
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
env:
DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: julia --project=docs/ docs/make.jl
6 changes: 6 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,12 @@
[![Build Status](https://ci.appveyor.com/api/projects/status/github/SimonDanisch/GeometryBasics.jl?svg=true)](https://ci.appveyor.com/project/SimonDanisch/GeometryBasics-jl)
[![Codecov](https://codecov.io/gh/SimonDanisch/GeometryBasics.jl/branch/master/graph/badge.svg)](https://codecov.io/gh/SimonDanisch/GeometryBasics.jl)

**Documentation**: [![][docs-stable-img]][docs-stable-url] [![][docs-master-img]][docs-master-url]

[docs-stable-img]: https://img.shields.io/badge/docs-stable-lightgrey.svg
[docs-stable-url]: http://juliageometry.github.io/GeometryBasics.jl/stable/
[docs-master-img]: https://img.shields.io/badge/docs-dev-blue.svg
[docs-master-url]: http://juliageometry.github.io/GeometryBasics.jl

# GeometryBasics.jl

Expand Down
3 changes: 3 additions & 0 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
GeometryBasics = "5c1252a2-5f33-56bf-86c9-59e7332b4326"
6 changes: 3 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ makedocs(
"meshes.md",
"decomposition.md",
"distancefields.md",
"metadata.jl",
"metadata.md",
"api.md",
],
modules = [GeometryTypes]
modules = [GeometryBasics]
)

deploydocs(
repo = "github.com/JuliaGeometry/GeometryTypes.jl.git",
repo = "github.com/JuliaGeometry/GeometryBasics.jl.git",
push_preview = true
)