Fix doc preview in PR CI

napari / docs

Documentation for napari (other than API docs)

BSD 3-Clause "New" or "Revised" License

11 stars 36 forks source link

Fix doc preview in PR CI #389

Closed lucyleeow closed 5 months ago

lucyleeow commented 6 months ago

Update names downloading artifacts: we changed workflow name and build dir from 'docs' to 'html' -> this updates this and updates the images to match new names
Adds more info on difference between local vs PR preview and circle CI vs artifact download preview.

psobolewskiPhD commented 6 months ago

Wait, that's the contributing documentation guide, so for this repo. In this repo, on PRs, we still have the action that make the artifact. I think it's useful to check it -- it's more of the ground truth than the CircleCI because in principle it's what gets deployed to gh-pages, same runners, same workflow now (since it was unified with all the consequences). So I'm not sure I like totally deleting the info on downloading the artifact...

(That said on napari/napari it's just circleCI now, which is fine I think because most docs things will go through this repo.)

lucyleeow commented 6 months ago

No problem, we can document both. Still need to update the docs as we get to the artifact a different way now.

lucyleeow commented 6 months ago

I've updated everything (since we updated the CIs things have changed names) - hopefully its okay, I'll come back and double check later!

lucyleeow commented 6 months ago

🤦 oh man I just realised that you could still download the artifact and the old docs described how to do both and were fine really. Oh well updated names and added more info