Specific file is not watched

[fredrikekre]

Hi, I tried LiveServe.servedocs with Literate and it seems to work except the file docs/src/outputformats.md is not watched for some reason. Changes to all other files trigger a rebuild.

I ran this from the Literate.jl root:

julia --project=docs -e 'using LiveServer; LiveServer.servedocs(; skip_dir="docs/src/generated")

The only unique thing with this file (compared to the other) is that there is also a file docs/src/outputformats.jl, but don't quite know why that would matter.

[fredrikekre]

Yep, seems like that is the problem. Changing it to outputformats2.md works.

[fredrikekre]

LiveServer.jl/src/utils.jl

Lines 75 to 87 in e0301cb

	if isempty(literate)
	# assumption is that the scripts are in `docs/src/...` and that the generated markdown
	# goes in exactly the same spot so for instance:
	# docs
	# └── src
	# ├── index.jl
	# └── index.md
	for wf ∈ dw.watchedfiles
	spath = splitext(wf.path)
	spath[2] == ".jl" || continue
	k = findfirst(e -> splitext(e.path) == (spath[1], ".md"), dw.watchedfiles)
	k === nothing || push!(remove, k)
	end

Why is that there?

[tlienart]

Hello Fredrik,

The procedure expected with literate is outlined here: https://tlienart.github.io/LiveServer.jl/dev/man/ls+lit/#Modifying-the-make-file meaning that if there's a file literate_src.jl you'll get a literate_src.md in the same folder which shouldn't be watched otherwise there's an infinite triggering (make.jl file executed -> generates .md file -> triggers -> make.jl file executed)

I think here the issue is rather that you're not using Literate and so this code should not apply to your case. I think the correct thing to do would be to have default literate=nothing) (meaning that we don't expect to use Literate), and then if the user wants either literate="" or literate="path/to/literate_files/ .

[fredrikekre]

The procedure expected with literate is outlined here: https://tlienart.github.io/LiveServer.jl/dev/man/ls+lit/#Modifying-the-make-file meaning that if there's a file literate_src.jl you'll get a literate_src.md in the same folder which shouldn't be watched otherwise there's an infinite triggering (make.jl file executed -> generates .md file -> triggers -> make.jl file executed)

Yes, but I thought it was opt-in? I am not specifying that I am using Literate here, but perhaps I misunderstood the meaning of the literate keyword argument.

[tlienart]

yes this is the problem; the default is literate="" which still assumes that you might be using literate but in the current directory.

What I'm suggesting is to have default be literate=nothing and then have the user specify explicitly either literate="" or literate="path/to" in which case the behaviour would be triggered. I'll add that now