Skip to content

Commit

Permalink
move documentation to main branch
Browse files Browse the repository at this point in the history
  • Loading branch information
michael-petersen committed Jun 9, 2024
1 parent f42f4ec commit 2f27102
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 1 deletion.
2 changes: 1 addition & 1 deletion docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,4 @@ makedocs(sitename = "AstroBasis.jl",
],
format = Documenter.HTML(prettyurls=false))

deploydocs(repo="github.com/JuliaStellarDynamics/AstroBasis.jl",devbranch="documentation")
deploydocs(repo="github.com/JuliaStellarDynamics/AstroBasis.jl",devbranch="main")
6 changes: 6 additions & 0 deletions docs/src/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,9 @@
*Bi-orthogonal bases for galactic dynamics in Julia*

AstroBasis.jl implements several common basis sets (see 'Bases') in galactic dynamics, with a common interface (see 'Common Interfaces'). A quickstart is availabe, which will walk you through how to construct an image of the basis sets.

---
## Installation

For installation and first use test, follow the instructions on the github [README](https://github.com/JuliaStellarDynamics/AstroBasis.jl).

0 comments on commit 2f27102

Please sign in to comment.