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 build stage for documentation #1485

Merged
merged 3 commits into from Sep 23, 2018
Merged

Add build stage for documentation #1485

merged 3 commits into from Sep 23, 2018

Conversation

odow
Copy link
Member

@odow odow commented Sep 23, 2018

This PR adds a documentation build stage to Travis, following these instructions:
https://discourse.julialang.org/t/psa-use-a-project-for-building-your-docs/14974

Let's see what happens.

@codecov
Copy link

codecov bot commented Sep 23, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1485   +/-   ##
=======================================
  Coverage   88.83%   88.83%           
=======================================
  Files          27       27           
  Lines        3655     3655           
=======================================
  Hits         3247     3247           
  Misses        408      408

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 d2717b0...6bce2b4. Read the comment docs.

@codecov
Copy link

codecov bot commented Sep 23, 2018

Codecov Report

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

Impacted file tree graph

@@           Coverage Diff           @@
##           master    #1485   +/-   ##
=======================================
  Coverage   88.83%   88.83%           
=======================================
  Files          27       27           
  Lines        3655     3655           
=======================================
  Hits         3247     3247           
  Misses        408      408

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 d2717b0...ae16e3d. Read the comment docs.

@odow
Copy link
Member Author

odow commented Sep 23, 2018

@fredrikekre
Copy link

You need

# Workaround for JuliaLang/julia/pull/28625
if Base.HOME_PROJECT[] !== nothing
    Base.HOME_PROJECT[] = abspath(Base.HOME_PROJECT[])
end

at the top of docs/make.jl, see Gotcha 2 I added to the top post of https://discourse.julialang.org/t/psa-use-a-project-for-building-your-docs/14974

@odow
Copy link
Member Author

odow commented Sep 23, 2018

Oops, sorry, I should have tried that first. It might be worth editing the discourse post because the word "might" put me off, and I had a quick look at the Julia issue and it didn't seem relevant.

Maybe say:

If you encounter an error like

ERROR: LoadError: ArgumentError: Package XXX not found in current path:
- Run `Pkg.add("XXX")` to install the XXX package.

you've run into JuliaLang/julia#28625 which is a bug in Julia ...

@fredrikekre
Copy link

Yea, updated. It is actually if you have doctests that you get that without the workaround.

@odow
Copy link
Member Author

odow commented Sep 23, 2018

Great, thanks for your help!

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

Successfully merging this pull request may close these issues.

None yet

3 participants