Skip to content

Adds an options to use listings for code highlighting in LaTeX #2349

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Adds an options to use listings for code highlighting in LaTeX #2349

wants to merge 5 commits into from

Conversation

@BambOoxX
Copy link

@BambOoxX BambOoxX commented Nov 16, 2023 •
edited
Loading

Fixes #2309

@mortenpi mortenpi changed the title 2309 listings Adds an options to use listings for code highlighting in LaTeX Dec 2, 2023
@mortenpi mortenpi added Type: Enhancement Format: LaTeX Related to the LaTeX / PDF output labels Dec 2, 2023
mortenpi
mortenpi reviewed Dec 2, 2023
View reviewed changes
Copy link
Member

@mortenpi mortenpi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The approach looks fine. Code needs a few cleanup things, and I would love to get the showcase build with listings passing on CI before merging.

@BambOoxX
Copy link
Author

BambOoxX commented Dec 1, 2024

@mortenpi I really did not have time to push this further so far... What can I do to revive this ?

@odow odow mentioned this pull request Jan 15, 2025
Merged
@fingolfin
Copy link
Collaborator

fingolfin commented Oct 31, 2025

@BambOoxX to revive this, the first step would be to resolve the merge conflicts that accumulated over time. Then CI has a chance to run and we can see if tests pass.

fingolfin
fingolfin reviewed Oct 31, 2025
View reviewed changes
assets/latex/jlcode.sty

% defining the jlcode package
\def\fileversion{6.1}
\def\filedate{2022/05/03}
Copy link
Collaborator

@fingolfin fingolfin Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

at the top of the file the copyright is only listed as 2018, here it says 2022...?!

assets/latex/jlcode.sty
@@ -0,0 +1,2247 @@
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%%
%%% jlcode.sty
Copy link
Collaborator

@fingolfin fingolfin Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a home repository for this style file? Or some other source we can list?

@fingolfin
Copy link
Collaborator

fingolfin commented Oct 31, 2025

OK, I overhauled this PR: first squashed everything into a single commit based on the merge-base commit with master. Then remove most of the settings=... bits (they just cause merge conflicts); and merged master. It could be squashed once again into a single commit if desired. I also removed several gratuitous changes (e.g. we have to check for latexmk not pdflatex because we actually call latexmk)

fingolfin
fingolfin reviewed Oct 31, 2025
View reviewed changes
test/examples/make.jl
examples_latex_texonly_doc = if "latex_texonly" in EXAMPLE_BUILDS
@info("Building mock package docs: LaTeXWriter/latex_texonly")
@quietly makedocs(
makedocs(
Copy link
Collaborator

@fingolfin fingolfin Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I assume this was removed for debugging but should be added back before merging?

Suggested change
makedocs(
@quietly makedocs(

fingolfin
fingolfin reviewed Oct 31, 2025
View reviewed changes
test/examples/make.jl

examples_latex_listings_texonly_doc = if "latex_listings_texonly" in EXAMPLE_BUILDS
@info("Building mock package docs: LaTeXWriter/latex_listings_texonly")
makedocs(
Copy link
Collaborator

@fingolfin fingolfin Oct 31, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
makedocs(
@quietly makedocs(

@fingolfin fingolfin mentioned this pull request Nov 1, 2025
Closed
@fingolfin fingolfin force-pushed the 2309-listings branch 2 times, most recently from 3ceab35 to 6fbcc31 Compare November 4, 2025 00:18
@fingolfin
Adjust test outputs in test/examples to avoid warnings
4af527b 
... so that we can run those tests with `warnonly = false`,
at least in some specific Julia versions.
@fingolfin
Resolve Windows issue (hopefully)
2a0b103
@fingolfin
Add to changelog
80f2540
@fingolfin
Copy link
Collaborator

fingolfin commented Nov 7, 2025

It seems the generated reference file contains commit SHA's of the HEAD commit or so?!

┌ Error: Generated files did not agree with reference, diff follows.
│   a = "/home/runner/work/Documenter.jl/Documenter.jl/test/examples/builds/latex_listings_texonly/DocumenterLaTeX.tex"
│   b = "/home/runner/work/Documenter.jl/Documenter.jl/test/examples/references/latex_simple_listings.tex"
└ @ Main ~/work/Documenter.jl/Documenter.jl/test/examples/tests.jl:64
1894c1894
< \href{[https://github.com/JuliaDocs/Documenter.jl/blob/cced9e21e7c698180e719bfe4d1063a8bbe76371/src/makedocs.jl#L322}{\texttt{source}](https://github.com/JuliaDocs/Documenter.jl/blob/cced9e21e7c698180e719bfe4d1063a8bbe76371/src/makedocs.jl#L322{\texttt{source}})}
---
> \href{[https://github.com/JuliaDocs/Documenter.jl/blob/eefca50709ea92ad7d4ff7fdd58d2b22dae8d5c9/src/makedocs.jl#L322}{\texttt{source}](https://github.com/JuliaDocs/Documenter.jl/blob/eefca50709ea92ad7d4ff7fdd58d2b22dae8d5c9/src/makedocs.jl#L322{\texttt{source}})}
1924c1924
< \href{[https://github.com/JuliaDocs/Documenter.jl/blob/cced9e21e7c698180e719bfe4d1063a8bbe76371/src/makedocs.jl#L346}{\texttt{source}](https://github.com/JuliaDocs/Documenter.jl/blob/cced9e21e7c698180e719bfe4d1063a8bbe76371/src/makedocs.jl#L346{\texttt{source}})}
---
> \href{[https://github.com/JuliaDocs/Documenter.jl/blob/eefca50709ea92ad7d4ff7fdd58d2b22dae8d5c9/src/makedocs.jl#L346}{\texttt{source}](https://github.com/JuliaDocs/Documenter.jl/blob/eefca50709ea92ad7d4ff7fdd58d2b22dae8d5c9/src/makedocs.jl#L346{\texttt{source}})}

@mortenpi any idea?

@mortenpi
Copy link
Member

mortenpi commented Nov 14, 2025

It seems the generated reference file contains commit SHA's of the HEAD commit or so?!

These look like source links? They would either point to a branch or the current commit. IIRC, we have an option for that.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mortenpi mortenpi mortenpi left review comments

@fingolfin fingolfin fingolfin left review comments

Assignees

No one assigned

Labels

Format: LaTeX Related to the LaTeX / PDF output Type: Enhancement

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Switch or at least support code listings in LaTeX using the listings package instead of minted

3 participants

@BambOoxX @fingolfin @mortenpi