Documenter.jl Error: no docs found

Marco-Congedo · June 18, 2024, 3:26pm

I am working on the documentation of a new package to be released soon. I am running locally a very simple version of the make.jl file to debug a partial version of the documentation using argument remotes = nothing in the makedocs() function. I have plenty of errors like this:

┌ Error: no docs found for 'correlationMcTest' in `@docs` 
block in src\multiple comparisons tests.md:44-58
│ ```@docs
│ correlationMcTest
# more symbols in this docs block

This error in particular, the first throw by Documenter.jl, arises in unit docs\src\multiple comparisons tests.md.
The symbols in the @docs block are all exported in the main module src\PermutationTests.jl and the documentation that is not found is in unit \src\multCompTests_API.jl.

I am using the latest version of Documenter.jl (1.4.1). I am doing the same thing i have been doing for several packages i published and documented, but I guess i am missing something obvious.

I published all the code here:

Can someone please tell me what i am missing or doing wrong?

kellertuer · June 18, 2024, 4:06pm

At first glance (I did not clone your repo) It looks like your exports might not actually be exports since you have an empty line in line 21 at

github.com

Marco-Congedo/PermutationTests.jl/blob/2f7ed8e3b53f5cbbb21c96c6ccd5b6f65842923c/src/PermutationTests.jl#L20-L22


      
          export
          # from this module
          Statistic,

and since none of them are exported, they are private (Packagename.function would still work). So if you load your package, are the commands exported?

Marco-Congedo · June 18, 2024, 4:23pm

Yeah, they are exported, the comment does not do anything. I can use them activating the package without specifying the package name. All examples in the doc work fine

kellertuer · June 18, 2024, 6:43pm

Hm, ok: I was not sure about that, but you might be right that after `export´ Julia looks for the next literal word as a name to export and the same after commas.

Next idea – is it enough just to push the ../src zo she load path? That might also be dangerous if you execute the makefile from other than the docs folder. Again, I am not sure, but what I am used to see (or do myself) is to put the package from the repo (with a bit safer form than ../src) into development mode like

github.com

JuliaManifolds/Manopt.jl/blob/befce2951e1e72099966a60eeb49429f712eb66c/docs/make.jl#L37


      
              )
              exit(0)
          end
          
          #
          # (a) if docs is not the current active environment, switch to it
          # (from https://github.com/JuliaIO/HDF5.jl/pull/1020/) 
          if Base.active_project() != joinpath(@__DIR__, "Project.toml")
              using Pkg
              Pkg.activate(@__DIR__)
              Pkg.develop(PackageSpec(; path=(@__DIR__) * "/../"))
              Pkg.resolve()
              Pkg.instantiate()
          end
          
          # (b) Did someone say render?
          if "--quarto" ∈ ARGS
              using CondaPkg
              CondaPkg.withenv() do
                  @info "Rendering Quarto"
                  tutorials_folder = (@__DIR__) * "/../tutorials"

as well as activating the docs/ environment.

Marco-Congedo · June 18, 2024, 9:00pm

I tried, but this does not seem to be the problem. I am rewriting the docs in the .jl files; it seems the newer versions of Documenter.jl are more strict on how these should be written. Thanks for your help Ronny.

kellertuer · June 18, 2024, 9:04pm

From 1.0 onwards they are a bit more strict, but besides these two Tipps I currently do not see why it does not find your docs; hope someone else can help then