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

Fix documentation versions #78

Closed
graeme-a-stewart opened this issue Oct 7, 2024 · 10 comments · Fixed by #82
Closed

Fix documentation versions #78

graeme-a-stewart opened this issue Oct 7, 2024 · 10 comments · Fixed by #82
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@graeme-a-stewart
Copy link
Member

At the moment we don't have versioned documentation correctly produced - we only get the main branch, i.e., dev documentation.

@Moelf pointed to Lux.jl as an example that has managed to get this correct - it's probably a minor configuration issue.

However, documentation for older releases may need to be created by hand.

@graeme-a-stewart graeme-a-stewart added the documentation Improvements or additions to documentation label Oct 7, 2024
@graeme-a-stewart graeme-a-stewart self-assigned this Oct 7, 2024
@graeme-a-stewart
Copy link
Member Author

I am having real issues with Vitepress in that it seems to be impossible to get a working preview of the site. The suggestions in https://luxdl.github.io/DocumenterVitepress.jl/v0.1.3/getting_started#Preview-Documentation-Development-Instantly are complicated, require changes to be done, then undone and, worst of all, they didn't even work for me.

So for now I have removed the DocumenterVitepress setup via #80.

@Moelf
Copy link
Member

Moelf commented Oct 8, 2024

locally? well you can always do that and add VitePress later

@graeme-a-stewart
Copy link
Member Author

Which is a pain when certain things aren't working... I want to get the versioning sorted, then return to reenabling the fancy stuff

@graeme-a-stewart
Copy link
Member Author

It is actually really important to have a good local preview when working on documentation improvements

@Moelf
Copy link
Member

Moelf commented Oct 8, 2024

I have it working locally, but i remember it was a bit pain to set up

@graeme-a-stewart
Copy link
Member Author

Yeah, too fiddly for today ;)

I have now fixed the documentation and recreated manually all of the past versions in the gh-pages branch. But I will keep this issue open until the next tag is made to check that Documenter.jl does the right thing with the next version.

@graeme-a-stewart
Copy link
Member Author

Creating the next tag, v0.4.2 did not result in a documenter run. I can't see anything wrong with the GH action, which is set to run on tag events (and looks just like many of the other actions in repositories with Documenter.jl).

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

Either the document action is not being triggered, or it's triggered and is failing.

@Moelf
Copy link
Member

Moelf commented Oct 8, 2024

I'm pretty sure you need

DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

ref: https://documenter.juliadocs.org/stable/man/hosting/#GitHub-Actions

@graeme-a-stewart
Copy link
Member Author

I also noticed that late last night! 🤞 it solves the issue.

28d7f0d

@Moelf
Copy link
Member

Moelf commented Oct 23, 2024

image

I don't see we have added DOCUMENTER_KEY

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

Successfully merging a pull request may close this issue.

2 participants