Skip to content

Commit

Permalink
Merge pull request #40 from bcbi/AshlinHarris-patch-1
Browse files Browse the repository at this point in the history 
Update documentation.yml
  • Loading branch information
@AshlinHarris
AshlinHarris authored Sep 2, 2024
2 parents a631a26 + 572a6a9 commit 144f88e
Show file tree
Hide file tree
Showing 3 changed files with 16 additions and 8 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/documentation.yml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ jobs:
- uses: julia-actions/setup-julia@v2
with:
version: '1.10'
- uses: julia-actions/cache@v1
- uses: julia-actions/cache@v2
- name: Install dependencies
run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
- name: Build and deploy
Expand Down
3 changes: 3 additions & 0 deletions docs/Project.toml
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
[deps]
Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
19 changes: 12 additions & 7 deletions docs/make.jl
View file
Original file line number Diff line number Diff line change
@@ -1,11 +1,16 @@
using Documenter, REDCap
using Documenter
using Literate
using REDCap

makedocs()
makedocs(
sitename = "REDCap",
format = Documenter.HTML(),
modules = [REDCap]
)

deploydocs(
deps = Deps.pip("mkdocs==0.17.5", "mkdocs-material==2.9.4"),
repo = "github.com/bcbi/REDCap.jl.git",
julia = "1.0",
osname = "linux"
)
#deps = Deps.pip("mkdocs==0.17.5", "mkdocs-material==2.9.4"),
repo = "github.com/bcbi/REDCap.jl.git",
#julia = "1.0",
#osname = "linux"
)

2 comments on commit 144f88e

@AshlinHarris
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@JuliaRegistrator register

@JuliaRegistrator
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Registration pull request created: JuliaRegistries/General/114371

Tip: Release Notes

Did you know you can add release notes too? Just add markdown formatted text underneath the comment after the text
"Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the
release that TagBot creates. i.e.

@JuliaRegistrator register

Release notes:

## Breaking changes

- blah

To add them here just re-invoke and the PR will be updated.

Tagging

After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

git tag -a v2.3.0 -m "<description of version>" 144f88e0a60a879a366d039ee8989b6b4e11d372
git push origin v2.3.0

Please sign in to comment.