WayScience / coSMicQC

Single cell Morphology Quality Control (coSMicQC)
https://wayscience.github.io/coSMicQC/
BSD 3-Clause "New" or "Revised" License
6 stars 2 forks source link

Add presentation section to docsite #106

Closed d33bs closed 1 month ago

d33bs commented 1 month ago

Description

This PR adds a presentation section to the docsite for viewing posters and similar materials. I've added the existing poster there as well. I needed to make adjustments to how the poster publishes in order to make this happen (Quarto does not allow for external directory output on it's own, so I used mv here to accomplish this through poe).

I've tested this locally as best as I could but we may run into issues depending on what happens during GitHub Actions or GitHub Pages processing.

Closes #98

What kind of change(s) are included?

Checklist

Please ensure that all boxes are checked before indicating that this pull request is ready for review.

d33bs commented 1 month ago

Thanks @jenna-tomkinson for the review! Will merge this in shortly.

For these types of website/docs updates, is there a way for me to pull it up to test if this is working for next time?

The docs changes can be previewed with:

# with sphinx-build (quicker)
poetry run sphinx-build docs/src docs/build
# open `docs/build/index.html` after a build

# with sphinx-multiversion (more accurate to what our docs are)
poetry run sphinx-multiversion docs/src docs/build
# open `docs/build/v0.0.11/index.html` (or related version) after a build

It's tricky because the local version of these docs won't work exactly as we see in the docsite because of the linking and build process. We also can't use certain HTTP functionality when we don't have a web host (local files through the browser act differently than they do when served by a web host like GitHub Pages). There are some additional configurations like the changes in this PR which move files around to help prepare for web hosting through GitHub pages (see .github/workflows/publish-docs.yml for more of an outline on what happens). These are some customizations to help make the project more cohesive or add functionality I thought might help share the work with others. We should update this through #107 for a better understanding in the contribution guide too!