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

Add Documentation.yml GitHub action #25

Closed
wants to merge 2 commits into from
Closed

Add Documentation.yml GitHub action #25

wants to merge 2 commits into from

Conversation

francescoalemanno
Copy link

@francescoalemanno francescoalemanno commented Mar 13, 2020

Hi Tamas,

this way of building docs is much easier and cleaner than using travis,
the only caveat is:
JuliaDocs/Documenter.jl#1177
TL;DR:
the user has to trigger for the first time a build on the docs via a no-op commit to gh-pages branch
it still seems much prettier than adding keys to the repo manually

and if manually triggering github to rebuild the pages is too much to bear, the user can still add the traditional DOCUMENTER_KEY environment variable

all in all this way of deploying docs to me it seems to be much smoother to new users

let me know what you think

Best regards,

Francesco

@codecov
Copy link

codecov bot commented Mar 13, 2020

Codecov Report

Merging #25 into master will not change coverage.
The diff coverage is n/a.

Impacted file tree graph

@@           Coverage Diff           @@
##           master      #25   +/-   ##
=======================================
  Coverage   98.48%   98.48%           
=======================================
  Files           1        1           
  Lines          66       66           
=======================================
  Hits           65       65           
  Misses          1        1

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 1e4e1e2...474cefb. Read the comment docs.

@anandijain
Copy link

anandijain commented Mar 23, 2020

Could you explain what you mean by no-op commit to gh-pages?
What should I do, so that the docs will start building?
Thanks!


Edit: I think I got it, running deploydocs creates the branch, but you have to git checkout gh-pages and commit.

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