Skip to content
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

TeXmacs auto-build research papers #2

Open
Songtech-0912 opened this issue Jan 11, 2025 · 0 comments
Open

TeXmacs auto-build research papers #2

Songtech-0912 opened this issue Jan 11, 2025 · 0 comments

Comments

@Songtech-0912
Copy link
Contributor

Songtech-0912 commented Jan 11, 2025

Right now, the PDF versions and HTML distributions of papers/reports we write are manually-generated. This is absolutely not scalable and means any change has to be made meticulously by hand (and there are a lot of manual tweaks/hacks that had to be added to make everything work). We would much prefer an automated process, roughly something like this:

  • Every paper is added to a papers.yml config file which specifies the name of each of the papers, which we write in TeXmacs out of convenience (because LaTeX is incredibly arduous to set up locally, requires installing a lot of packages even with a modern distribution unless you use an experimental LaTeX engine like Tectonic, and also has so many commands and such a...unique syntax that it's easy to forget, making writing papers incredibly slow)
    • This also allows us to specify that some papers be drafts that won't be built by the build scripts, giving us more flexibility in authoring papers/technical reports.
  • The PDF is generated by running TeXmacs in headless mode to produce a PDF
  • The web version is generated by (again) running TeXmacs in headless mode, then applying our manual customizations to the output HTML via a Python script/bash script
  • We can also optionally generate LaTeX files for each paper by (again) running headless TeXmacs and we can save a zip archive of all of the LaTeX outputs of every paper by using a GitHub action to push that zip archive to github releases
    • This might also be helpful for submissions to journals
  • The whole process is done by GitHub actions to automatically build the web and PDF papers on every commit, which avoids needing to add those paper HTML/PDF versions into the repo itself (which would mean cluttering the repo with heavy HTMLs and PDFs on every commit, which Git is not designed to diff efficiently)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

No branches or pull requests

1 participant