-
Notifications
You must be signed in to change notification settings - Fork 35
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
Revamp docs #77
Revamp docs #77
Conversation
Nevermind, all the exports are back. |
Thanks for this, it already looks quite comprehensive to me. Ready to merge if you are, should anything special be done to make the Github actions work, I've never used those before. |
Np, thanks for a cool package! I don't think that you need to do anything special to set up github actions. I think Documenter will automatically create a Also note that documentation won't build until tests pass...there might be a way to get around this? Once it's up and working, you can delete the travis.yml file. You can disable appveyor too because github actions can test on windows, but you'll have to change the settings to add windows. Maybe wait a couple of days to merge? I'm still messing around with the package a bit. |
Nevermind, I think I'm happy with this now |
OK, I merged it and removed Travis and Appveyor. Locally on Linux the doctests sometimes give unexpected output due to OpenGL warnings, I don't know how to make the tests ignore that. |
I've never used it, but I think there's a way to filter doctests here |
@barche I looked at the gh pages branch and there's documentation there! Just enable it by toggling the "Source" option in the GitHub Pages settings (just click settings then scroll down) |
It was all enabled, I think it failed because of JuliaDocs/Documenter.jl#1177. Worked around it by adding a custom token, the docs are there now, thanks! |
So... this is a WIP but I'm not sure I'll be able to make much more progress. I've made the following changes:
@expand_dots
, because it didn't seem to work on 1.4I haven't documented any of the GR or JuliaCanvas stuff, in part because it's marked as experimental, but mostly because I can't figure it out. I think most of the docs are correct, but I'm sure there's stuff I've gleaned wrong. I'm still confused by why it's necessary to pass empty
QUrl
andqmlcontext
s.