Build docs in CI #19
Build docs in CI #19
Conversation
Codecov Report
@@ Coverage Diff @@
## main #19 +/- ##
=======================================
Coverage 67.33% 67.33%
=======================================
Files 7 7
Lines 799 799
=======================================
Hits 538 538
Misses 261 261
|
|
CI in 3b94cf9 failed for the right reasons! |
|
Does anything more actually need to happen for this to be ready to merge? |
|
The commits in this PR reflect my actual development process. They are useful for me now in keeping track of what I've done and still need to do and making sense of CI results. There's no need to erase this history, but they should not make it into the main branch's history. I recommend merging this via "squash and merge". Making documentation reasonably bug-free and checking that all the links work in all the context this documentation appears in is still a big todo, but this makes Docs build and CI green, and does not introduce much hackieness (aside from those hardcoded URLs from 9067fa1) so I think it's ready to go! |
|
Thanks for doing this Lilith! I take it it's good to merge? |
|
Update: actually read the last few words of your comment 😅. Thanks again 🙂 |
I'm thinking I might just copy the approach of https://github.com/JuliaLang/Distributed.jl/blob/master/docs/make.jl and set: checkdocs = :exports,
warnonly = [:cross_references], |
|
I've got a few tweaks I want to try, if they don't pan out I'll just revert to the current state. |
tecosaur
force-pushed
the
lh/docs
branch
3 times, most recently
from
d1066d4 to
5c32b23
Compare
Before now, documentation build errors would only be caught when testing manually or PRing a new version of StyledStrings.jl to the main Julia repo. To address this, a new CI task is introduced, and a few small changes made to make automated docs builds possible, namely: - Tweaking the documentation workflow - Introducing some docs build scripts under docs/ - Fixing a dodgy jldoctest We also add a documentation page for the internals.
|
I think this is a little better, let's give it a shot :) |
|
You deleted all the history and made multiple force pushes so I can no longer see my history nor get an ergonomic view of what you changed since my latest changes :( |
|
Oh the history is still there, it's just detached 🙂 (and GitHub seems to be doing a worse-than-usual job showing it). Here's a diff from the last commit you pushed to what I merged: https://github.com/JuliaLang/StyledStrings.jl/compare/090c05f92c3e7e..c49ae82f2b1765. Short rundown:
|
|
Also, looks like the inclusion of |
The two commits build everything and fail due to failed doctests due to #8
The remaining commits should fix that failure, fix #8, make CI green, and unblock JuliaLang/julia#51869