Latex: add a template preamble file as a support file

[Octachron]

The latex renderer currently creates one latex file by module, and expects the user to provide the latex preamble.

Since the minimal preamble is not that small (see https://github.com/ocaml/odoc/blob/master/test/latex/expect/visualizer.tex for a not completely minimal example), it probably makes sense to provide a template preamble file as an odoc support-files template.

[somya104]

Hey @jonludlam ! I am Somya and I am an outreachy applicant.
I am interested in contributing to the odoc project though I'm still learning OCaml.
Apart from OCaml, what else do I require to know in order to work on this particular issue?
Also, I have been working on a few issues in the website project too.

[jonludlam]

Oops, missed this - though I'm going to suggest the same thing as in issue #575 - that is, it may make more sense for an initial contribution at ocaml.org first and then have a crack at this one, as there will be more 'getting started' help over there. Having said that though, the bits to look at for this issue are the Support_files module, the dune rule that creates the Css_file module, and the main.ml section that defines the support-files CLI sub-command.

[somya104]

Okay. Thank you so much, that was really helpful! :)

[jonludlam]

For reference, the file visualizer.tex mentioned above has been removed from the repo, but is still available here.

We'll want to treat that file in a very similar way to odoc.css and highlight.pack.js - use the dune rule to create a new module called latex_preamble.ml. We'd then add a flag --latex to the support-files odoc command (like the without-theme flag here) which would cause it to output the file named 'odoc_preamble.tex' into the specified output directory.

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. The main purpose of this is to keep the issue tracker focused to what is actively being worked on, so that the amount and variety of open yet inactive issues does not overwhelm contributors.

An issue closed as stale is not rejected — further discussion is welcome in its closed state, and it can be resurrected at any time. odoc maintainers regularly check issues that were closed as stale in the past, to see if the time is right to reopen and work on them again. PRs addressing issues closed as stale are as welcome as PRs for open issues. They will be given the same review attention, and any other help.