Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Documentation build fixes #56

Merged
merged 6 commits into from
Oct 11, 2022
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
1 change: 1 addition & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ on:
push:
branches:
- main
- fergus/doc-debug
paths:
- docs/**.md
- docs/**.jl
Expand Down
4 changes: 0 additions & 4 deletions docs/Project.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,2 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Gradus = "c5b7b928-ea15-451c-ad6f-a331a0f3e4b7"
Plots = "91a5bcdd-55d7-5caf-9e0b-520d859cae80"
StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
6 changes: 5 additions & 1 deletion docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,18 @@ Gradus.jl allows for drastically different relativistic simulations to be comput

## Setup

Requires Julia >v1.6. First, install [Buckets.jl](https://github.com/fjebaker/Buckets.jl) and then add Gradus.jl:
Requires Julia >v1.6.

First, add [Buckets.jl](https://github.com/fjebaker/Buckets.jl) and then add Gradus.jl:


```
import Pkg
Pkg.add(url="https://github.com/fjebaker/Buckets.jl")
Plg.add(url="https://github.com/astro-group-bristol/Gradus.jl")
```


## About

Gradus.jl is a research tool for calculating geodesic paths in arbitrary space-times. It is currently work-in-progress, and breaking changes are frequent, as the interface is redesigned to match changing use-cases.
Expand Down