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.

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

Online documentation #12

Closed
serenity4 opened this issue Nov 19, 2020 · 8 comments
Closed

Online documentation #12

serenity4 opened this issue Nov 19, 2020 · 8 comments

Comments

@serenity4
Copy link
Collaborator

I would like to deploy some initial online documentation, but for this a DOCUMENTER_KEY variable must be set, as described in the Documenter docs. I currently don't have the permissions to add such a key, so would it be possible for someone with the right accesses to do that?

@SimonDanisch
Copy link
Member

image

@serenity4
Copy link
Collaborator Author

Thanks! Sorry to reopen that, but I got an access denied error. Did you also add the public key?

image

@serenity4
Copy link
Collaborator Author

@SimonDanisch Could you please add the public key if you did not already? It might fix it. Thanks!

@SimonDanisch
Copy link
Member

For what do you actually need that? I think I set that for travis, but I see that travis isn't even used :D
Should the repository switch to github-actions? I think that's what's widely used now for all Julia packages, and I think you don't even need to setup any keys!

@SimonDanisch
Copy link
Member

GLMakie shows how to setup xvfb to open windows: https://github.com/JuliaPlots/GLMakie.jl/blob/master/.github/workflows/ci.yml

@serenity4
Copy link
Collaborator Author

serenity4 commented Dec 28, 2020

Yes, I think we should switch to github-actions. I already pushed some workflows for documentation .github/workflows/Documenter.yml and for testing .github/workflows/Test.yml. Everything works fine with xvfb (so far), I have yet to fake inputs to actually test stuff (for now it loops forever because we never give it input, I'm working on it).

As for Documenter, it is used with a SSH deploy key, but it has trouble fetching the repo:

image

And from the error, it seems that we do need a public key along with the private key. From the repos I've been working on it has always been the case. Maybe authentication can be done with a Github Actions token, but apparently it does not build gh-pages.

Also, is there a way to retrigger a build? I can do it on my repos, but not here, so I can't test whether Documenter works without pushing a new commit.

@serenity4
Copy link
Collaborator Author

serenity4 commented Feb 27, 2021

@SimonDanisch could you please try to re-generate the private key and the public key via

using DocumenterTools
DocumenterTools.genkeys()

to try to solve this issue? By re-reading the error message I posted above, the very first line actually indicates an invalid format.

@SimonDanisch
Copy link
Member

Ok, hopefully this time:
image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants