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

Revamp docs #77

Merged
merged 10 commits into from
Jul 6, 2020
Merged

Revamp docs #77

merged 10 commits into from
Jul 6, 2020

Conversation

bramtayl
Copy link
Contributor

@bramtayl bramtayl commented Jul 3, 2020

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:

  • Added a github actions infrastructure to build the docs. Also has a lot of other bells and whistles
  • Moved lone docstrings to a separate file
  • Added a whole bunch of doc tests.
  • Unexported a couple of unused and undocumented functions...mostly because I couldn't figure out what they were for.
  • Rewrote @expand_dots, because it didn't seem to work on 1.4

I 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 and qmlcontexts.

@bramtayl
Copy link
Contributor Author

bramtayl commented Jul 4, 2020

Nevermind, all the exports are back.

@barche
Copy link
Collaborator

barche commented Jul 5, 2020

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.

@bramtayl
Copy link
Contributor Author

bramtayl commented Jul 6, 2020

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 gh-pages branch for you to host documentation. But I think you will have to tell github manually that gh-pages will contain documentation. See the comment here.

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.

@bramtayl
Copy link
Contributor Author

bramtayl commented Jul 6, 2020

Nevermind, I think I'm happy with this now

@barche barche merged commit 566966c into JuliaGraphics:master Jul 6, 2020
@barche
Copy link
Collaborator

barche commented Jul 6, 2020

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.

@bramtayl
Copy link
Contributor Author

bramtayl commented Jul 6, 2020

I've never used it, but I think there's a way to filter doctests here

@bramtayl
Copy link
Contributor Author

bramtayl commented Jul 9, 2020

@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)

@barche barche mentioned this pull request Jul 9, 2020
@barche
Copy link
Collaborator

barche commented Jul 9, 2020

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!

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

Successfully merging this pull request may close these issues.

2 participants