Skip to content

Commit

Permalink
Updated documentation workflo due to recent changes in JOSS review. N…
Browse files Browse the repository at this point in the history
…owow the website source is the public repo.
  • Loading branch information
nbwuzhe committed Jan 30, 2024
1 parent 4eeb778 commit 7075253
Show file tree
Hide file tree
Showing 4 changed files with 7 additions and 6 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ jobs:
with:
version: '1.9'
- name: Install dependencies
run: julia --project=docs -e 'using Pkg; Pkg.add("MRIGradients"); Pkg.develop(PackageSpec(path=pwd())); Pkg.add("Documenter"); Pkg.add("Literate"); Pkg.instantiate()'
run: julia --project=docs -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build Documents through Documenter.jl
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # For authentication with GitHub Actions token
Expand Down
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -3,3 +3,4 @@ LocalPreferences.toml
GIRFReco.code-workspace
docs/build/
docs/src/generated/
.vscode/
8 changes: 4 additions & 4 deletions docs/make.jl
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
push!(LOAD_PATH, "../src")
push!(LOAD_PATH, "../recon/")
push!(LOAD_PATH, "../utils/")
push!(LOAD_PATH, "../src/")
push!(LOAD_PATH, "../src/io/")
push!(LOAD_PATH, "../src/utils/")

using Documenter, Literate, GIRFReco

Expand All @@ -25,7 +25,7 @@ makedocs(
)

deploydocs(
repo = "github.com/BRAIN-TO/GIRFReco.git",
repo = "github.com/BRAIN-TO/GIRFReco.jl.git",
push_preview = true,
# deploy_config = Documenter.GitHubActions(),
devbranch = "main",
Expand Down
2 changes: 1 addition & 1 deletion docs/src/Utilities.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
```@autodocs
Modules = [GIRFReco]
Pages = ["utils.jl", "gradient_reader.jl"]
Pages = ["utils.jl", "gradient_reader.jl", "fieldmap_estimator.jl"]
```

0 comments on commit 7075253

Please sign in to comment.