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.

Sign up for GitHub

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

Fix deployment #20

Open
wants to merge 12 commits into
base: main
Choose a base branch
from
+20 −7
Open

Fix deployment #20

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
12 commits
Select commit Hold shift + click to select a range
e0e2c3c
add permissions
harisorgn Aug 29, 2024
74e6a4f
update make
harisorgn Aug 29, 2024
bf68f73
move `Project.toml`
harisorgn Aug 29, 2024
1b236ac
add name to `Project.toml`
harisorgn Aug 29, 2024
17e493e
add uuid
harisorgn Aug 29, 2024
54cd07a
add dummy src file
harisorgn Aug 29, 2024
23f2bca
restore the copies for reproducibility
harisorgn Aug 30, 2024
23ec2bf
add dummy Project.toml
harisorgn Aug 30, 2024
1eb9a48
move docs/Project.toml to its original place
harisorgn Aug 30, 2024
aacd754
enable linkcheck again
harisorgn Aug 30, 2024
49f3b38
Update Documentation.yml
ChrisRackauckas Aug 30, 2024
e7fc83d
Update Documentation.yml
ChrisRackauckas Aug 30, 2024
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
7 changes: 6 additions & 1 deletion .github/workflows/Documentation.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,11 @@ on:

jobs:
build:
permissions:
actions: write
contents: write
pull-requests: read
statuses: write
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
Expand All @@ -26,6 +31,6 @@ jobs:
- uses: julia-actions/julia-processcoverage@v1
with:
directories: src
- uses: codecov/codecov-action@v3
- uses: codecov/codecov-action@v4
with:
files: lcov.info
3 changes: 3 additions & 0 deletions docs/Project.toml → Project.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
name = "NeurobloxDocsHost"
uuid = "1bb98921-23b1-4067-a5f0-d1e925508412"
harisorgn marked this conversation as resolved.
Show resolved Hide resolved

[deps]
CSV = "336ed68f-0bac-5ca0-87d4-7b16caf5d00b"
DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
Expand Down
8 changes: 2 additions & 6 deletions docs/make.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,23 +1,19 @@
using Neuroblox
using Documenter

cp("./docs/Manifest.toml", "./docs/src/assets/Manifest.toml", force = true)
cp("./docs/Project.toml", "./docs/src/assets/Project.toml", force = true)
harisorgn marked this conversation as resolved.
Show resolved Hide resolved

DocMeta.setdocmeta!(Neuroblox, :DocTestSetup, :(using Neuroblox); recursive = true)

include("pages.jl")

makedocs(sitename = "Neuroblox",
authors = "Neuroblox Inc.",
modules = [Neuroblox],
clean = true, doctest = false, linkcheck = true,
clean = true, doctest = false, linkcheck = false,
warnonly = [:docs_block, :missing_docs],
format = Documenter.HTML(assets = ["assets/favicon.ico"]),
#canonical = "https://docs.sciml.ai/LinearSolve/stable/"),
pages = pages)
Copy link
Member

Choose a reason for hiding this comment

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

Why was this turned off?

Copy link
Member Author

Choose a reason for hiding this comment

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

It was giving an error on a couple of paper links, I only changed it to test for now, eventually it should be switched back.

Copy link
Member

Choose a reason for hiding this comment

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

Can you just white list the bad links?

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep, will check them again when we sort out the workflow and if need be will add them to linkcheck_ignore.


repo = "github.com/Neuroblox/NeurobloxDocsHost"
repo = "github.com/Neuroblox/NeurobloxDocsHost.git"

withenv("GITHUB_REPOSITORY" => repo) do
deploydocs(; repo = repo, push_preview = true)
Expand Down
3 changes: 3 additions & 0 deletions src/NeurobloxDocsHost.jl
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
module NeurobloxDocsHost

end
Loading