software-gardening / almanack

An open-source handbook of applied guidance and tools for sustainable software development and maintenance.
BSD 3-Clause "New" or "Revised" License
0 stars 2 forks source link

Add automated workflow publishing capabilities #29

Closed d33bs closed 1 month ago

d33bs commented 2 months ago

Description

This PR adds the capability to publish the Almanac's content automatically through GitHub Actions to address #18 . This adds HTML and PDF content through GitHub Pages. I tried to include ePub with this work but found that it's more complicated than the HTML or PDF content publishing process. As a result, I plan to address that aspect outside this PR, but I don't consider it critical (as both an offline and online option are provided here).

I also noticed that:

Thanks for any feedback you may have!

Closes #18 (#30 created for ePub tracking as follow-up)

What is the nature of your change?

Checklist

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

netlify[bot] commented 2 months ago

Deploy Preview for test-almanac ready!

Name Link
Latest commit 5840261d0bca25c6b860739a5a4e37871ca7114e
Latest deploy log https://app.netlify.com/sites/test-almanac/deploys/663d102a964c2d0008299ee5
Deploy Preview https://deploy-preview-29--test-almanac.netlify.app
Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

d33bs commented 1 month ago

Thanks @falquaddoomi and @gwaybio for the reviews!

I've noticed that, in the PDF version of the book and when you select the ".pdf" option from the "Download" dropdown in the HTML version, the PDF has a "Skip to main content" overlay on each page that covers up some of the content.

Thanks for bringing this up! I did some investigation and found that this relates to https://github.com/executablebooks/jupyter-book/issues/2045 and https://github.com/pydata/pydata-sphinx-theme/issues/1745 . I've added a bit of CSS to avoid displaying the "skip" content when printing through Chromium (which is how the PDF is compiled).