Fail to deploy from Documenter to GITHUB

General Usage Performance
,
1

I am working on Muscade.jl (work in progress!), and I have a first incomplete documentation I wish to deploy. Everything works fine… except I get a 404. Here is the dump:

My repo structure includes

Muscade
   docs
        make.jl
        Project.toml
        src
            index.md
            ...
        build
            index.html
            ...
    README.md
    src

My make.jl is

using Documenter, Muscade

repo = normpath((@__DIR__)*"/..")
push!(LOAD_PATH,joinpath(repo,"src"))
cp(joinpath(repo,"LICENSE.md"),joinpath(repo,"docs/src/LICENSE.md"),
   force=true)

makedocs(sitename ="Muscade.jl",
        format    = Documenter.HTML(prettyurls = false,
                                    sidebar_sitename = false),
        pages     = ["index.md",
                       ...],
                     source  = "src",
                     build   = "build"   
        )

deploydocs(repo = "github.com/SINTEF/Muscade.jl.git",target="build",devbranch="philippe")

Muscade/.github/workflows/documentation.yml contains

name: Documentation
on:
  push:
    branches:
      - main
    tags: '*'
  pull_request:

jobs:
  build:
    permissions:
      contents: write
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: julia-actions/setup-julia@v1
        with:
          version: '1.8'
      - name: Install dependencies
        run: julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd())); Pkg.instantiate()'
      - name: Build and deploy
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} # If authenticating with GitHub Actions token
        #  DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }} # If authenticating with SSH deploy key
        run: julia --project=docs/ docs/make.jl

In GITHUB | settings | pages, I have specified:
“deploy from a branch”, “main” “/root” and clicked save.

Building the doc locally works, I can navigate my doc.

I tag and commit a release, create an issue with “@juliaregistrator register”. The release goes well.
I point my browser to

https://sintef.github.io/muscade.jl/dev    
https://sintef.github.io/muscade.jl/stable 
https://sintef.github.io/Muscade.jl/

In the two first cases I get 404, in the later, I get to read my README.md file.

It’s difficult to move on without any feedback on what the problem is. Any suggestions?

2

Try ‘gh-pages’ ?

3

Oh thanks, I had missed that! :grinning: So now I have set “deploy from a branch”, “gh-pages”.

That alone does not make the doc appear. What triggers the doc-deploying bot?

  1. A commit & push on my philippe dev-branch does not seem to do so.
  2. Does it have to be a create new issue | @juliaregistrator register-release,
  3. or a GITHUB | releases | Draft a new release?
4

One thing to mention - I’ve noticed delays of up to 30 minutes before the documentation finally appears, although on other occasions it works almost instantly. Makes trouble-shooting frustrating… :grinning:

5

That’s a very important point! “will be compiled by the server in the next round…”

My question on “what triggers the doc-deploying bot?” still stands. Anyone?

6

Probably a commit and push to a github action.

Docs look OK :joy:

Purpose · Muscade.jl
Purpose · Muscade.jl2410×1777 803 KB

1 Like
7

VICTORY !!! :grinning: :sunny:

Hey wait, I was too fast: on what URL did you obtain this vision of beauty? I still get 404 on all the above-mentionned URLs… Some get to see my docs :stuck_out_tongue:

1 Like
8

Cool! By the way, are you running an old version of Documenter?

Yes, since there’s no badge I went for Reference manual · Muscade.jl …

9

How did you ever obtain that URL !?! :smile:
https://sintef.github.io/Muscade.jl/v0.3.2/index.html`

I have (yesterday) created a series of commits in the hope of deploying - I am now at 0.3.5. So we are looking at an “old” doc (though the text hasn’t changed).

I was using [e30172f5] Documenter v0.27.24, and am now updating it.

10

Your built documents go here:

so just link to the github-pages bit and point to the folder you want.

There are three difficult parts to developing Julia packages: learning Git(hub), setting up Documenter, and - well, that’s it, really… :joy:

2 Likes
11

Ahh, now I will be able to see what is available.
Thank you for taking the time!

1 Like
12

A new GitHub release, afaik

13

I will test that a little later. But I feel that with your help and Cormullion, I am going to get grip on this. Thank you!

14

This is what I do, specifically: Publish Docs · JuliaNotes.jl

2 Likes
15

Muito obrigado! I will read this very carefully!

1 Like