search

tomchor / Oceanostics.jl

Diagnostics for Oceananigans
https://tomchor.github.io/Oceanostics.jl/
MIT License
24 stars 8 forks source link

Add link to docs in `README` #130

Closed navidcy closed 1 year ago

navidcy commented 1 year ago

@tomchor this is a placeholder; feel free to edit as per your liking.

tomchor commented 1 year ago

We should register a new version after this, so that there's another version of docs other than dev.

tomchor commented 1 year ago

@navidcy feel free to merge if you don't have any more suggestions

tomchor commented 1 year ago

Hmm, seems like the docs for the registered version aren't deploying. Only the docs for dev appear online. Something must be missing from CI config?

navidcy commented 1 year ago

Hmm, seems like the docs for the registered version aren't deploying. Only the docs for dev appear online. Something must be missing from CI config?

Can you give me admin right on the repo to check the repo settings? Did you create the repo secret and public key for Documenter?

tomchor commented 1 year ago

I can't find an option to give you admin access. Maybe that feature is only available for enterprise users?

And no, I didn't create any deploy keys for this repo, but I think those aren't needed if you're deploying it from the gh-pages branch, no? At least that's what I understand when reading this page, although now that I read it again, the warning bubble here implies that a documenter key is needed. Plus two of the github actions do have mentions to a documenter key:

https://github.com/tomchor/Oceanostics.jl/blob/13ad95a572ee6801217c76c977c2382d04d2250d/.github/workflows/documentation.yml#L27-L29

https://github.com/tomchor/Oceanostics.jl/blob/13ad95a572ee6801217c76c977c2382d04d2250d/.github/workflows/TagBot.yml#L13-L15

tomchor commented 1 year ago

OKay, I followed the instructions here using as best as I could. Is there a way to test this without tagging a new version?

navidcy commented 1 year ago

Yeah, I'm pretty sure the tagbot needs it to trigger a docs built after a new release.

I manually created a release with a tag v0.11.1-docs. I didn't click the button to make this the latest release so that the release with the tag v0.11.1 is still considered the latest. I think that should trigger Documenter to built the docs for the v0.11.1 -- let's see.

navidcy commented 1 year ago

OK, the Documenter was triggered and pushed something in the gh-pages but then it does not appear in the docs website....

tomchor commented 1 year ago

Yeah, I see the files there in gh-pages. Weird, I'll investigate.