-
Notifications
You must be signed in to change notification settings - Fork 28
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
Fix generating the PDF and improve its formatting #393
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great PR, thank you for fixing this process and making the output much better as well! I have just one suggestion below, I'll just go ahead and commit that and then I think we can merge that. I have a few follow-up issues that I will create as well:
- Add headers to all chapters (you added one to the Technology overview page, others should have it as well).
- The PDF should have the version somewhere, preferably on the cover, but colofon or something is fine too.
- Your point: "Pushing to Zenodo is conditional (it will not be done when the workflow is triggered manually, in that case, it only generates the PDF, for testing purposes). This could be updated to push to sanbox.zenodo.org, but that should be a separate issue."
release: | ||
types: [published] | ||
|
||
jobs: | ||
generate: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/checkout@v4 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Great that you also updated the action versions (also for setup-node below)!
Changes in this PR
I updated the
page.yml
GitHub action to generate PDFs correctly, namely:docsify-pdf-converter
(outdated) todocker-docsify-pdf
. The new PDF generator creates a cleaner PDF that includes the TOC by default.sanbox.zenodo.org
, but that should be a separate issue.Smaller changes:
technology_overview
page as it was missing (noticeable when generating a PDF).Figures
not to clutter the root dir, but this can be changed.The PR resolves issues:
#270 (PDF is generated, Upload to Zenodo should be tested at the release)
#368 (TOC is now included
#369 (while the formatting is not perfect, it is much better, e.g., each section starts on a separate page, table formatting does not break, etc.)
Checklist
SIGNIFICANT changes / additions, e.g. new chapters
ALL contributions
python3 -m http.server 4000
and confirmed they work correctly.docker run --init -it -v `pwd`:/docs lycheeverse/lychee /docs --config=docs/lychee.toml
, at least for the files I changed.CITATION.cff
file.