HTMLWriter: ERROR: UndefRefError: access to undefined reference

[Nosferican]

Description

makedocs fails.

System info

julia> versioninfo(verbose = true)
Julia Version 1.3.0
Commit 46ce4d7933 (2019-11-26 06:09 UTC)
Platform Info:
  OS: Linux (x86_64-pc-linux-gnu)
  uname: Linux 4.9.184-linuxkit #1 SMP Tue Jul 2 22:58:16 UTC 2019 x86_64 x86_64
  CPU: Intel(R) Core(TM) i9-8950HK CPU @ 2.90GHz: 
              speed         user         nice          sys         idle          irq
       #1  2900 MHz     122268 s          0 s     211490 s   29164679 s          0 s
       #2  2900 MHz     165074 s          0 s     179917 s   29260143 s          0 s
       #3  2900 MHz     173429 s          0 s     156277 s   29349097 s          0 s
       #4  2900 MHz     152469 s          0 s     163295 s   29365681 s          0 s
       #5  2900 MHz     155505 s          0 s     163498 s   29358867 s          0 s
       #6  2900 MHz     151604 s          0 s     157308 s   29384472 s          0 s
       
  Memory: 1.9517478942871094 GB (536.0390625 MB free)
  Uptime: 299950.0 sec
  Load Avg:  0.0185546875  0.140625  0.150390625
  WORD_SIZE: 64
  LIBM: libopenlibm
  LLVM: libLLVM-6.0.1 (ORCJIT, skylake)
Environment:
  JULIA_EDITOR = "/usr/local/bin/code-server"
  JULIA_NUM_THREADS = 1
  PATH = /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin
  HOME = /home/coder
  TERM = xterm-256color
(docs) pkg> st
    Status `~/project/Github/uva-bi-sdad/Onboarding/docs/Project.toml`
  [e30172f5] Documenter v0.24.2

Reproducible Example

Structure was build with DocumenterTools.generate

julia> makedocs(
           sitename = "Onboarding",
           format = Documenter.HTML(),
           modules = [Onboarding]
       )
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
[ Info: ExpandTemplates: expanding markdown templates.
[ Info: CrossReferences: building cross-references.
[ Info: CheckDocument: running document checks.
┌ Warning: 2 docstrings potentially missing:
│ 
│     Onboarding.Onboarding
│     Onboarding.magic :: Tuple{}
└ @ Documenter.DocChecks ~/.julia/packages/Documenter/DQ9ei/src/DocChecks.jl:63
[ Info: Populate: populating indices.
[ Info: RenderDocument: rendering document.
[ Info: HTMLWriter: rendering HTML pages.
ERROR: UndefRefError: access to undefined reference
Stacktrace:
 [1] getproperty at ./Base.jl:20 [inlined]
 [2] render_sidebar(::Documenter.Writers.HTMLWriter.HTMLContext, ::Documenter.Documents.NavNode) at /home/coder/.julia/packages/Documenter/DQ9ei/src/Writers/HTMLWriter.jl:876
 [3] render_search(::Documenter.Writers.HTMLWriter.HTMLContext) at /home/coder/.julia/packages/Documenter/DQ9ei/src/Writers/HTMLWriter.jl:657
 [4] render(::Documenter.Documents.Document, ::Documenter.Writers.HTMLWriter.HTML) at /home/coder/.julia/packages/Documenter/DQ9ei/src/Writers/HTMLWriter.jl:593
 [5] runner(::Type{Documenter.Writers.HTMLFormat}, ::Documenter.Writers.HTMLWriter.HTML, ::Documenter.Documents.Document) at /home/coder/.julia/packages/Documenter/DQ9ei/src/Writers/Writers.jl:42
 [6] dispatch(::Type{Documenter.Writers.FormatSelector}, ::Documenter.Writers.HTMLWriter.HTML, ::Vararg{Any,N} where N) at /home/coder/.julia/packages/Documenter/DQ9ei/src/Utilities/Selectors.jl:167
 [7] render(::Documenter.Documents.Document) at /home/coder/.julia/packages/Documenter/DQ9ei/src/Writers/Writers.jl:107
 [8] runner(::Type{Documenter.Builder.RenderDocument}, ::Documenter.Documents.Document) at /home/coder/.julia/packages/Documenter/DQ9ei/src/Builder.jl:245
 [9] dispatch(::Type{Documenter.Builder.DocumentPipeline}, ::Documenter.Documents.Document) at /home/coder/.julia/packages/Documenter/DQ9ei/src/Utilities/Selectors.jl:167
 [10] #2 at /home/coder/.julia/packages/Documenter/DQ9ei/src/Documenter.jl:237 [inlined]
 [11] cd(::Documenter.var"#2#3"{Documenter.Documents.Document}, ::String) at ./file.jl:104
 [12] #makedocs#1 at /home/coder/.julia/packages/Documenter/DQ9ei/src/Documenter.jl:236 [inlined]
 [13] (::Documenter.var"#kw##makedocs")(::NamedTuple{(:sitename, :format, :modules),Tuple{String,Documenter.Writers.HTMLWriter.HTML,Array{Module,1}}}, ::typeof(makedocs)) at ./none:0
 [14] top-level scope at REPL[29]:1

[Nosferican]

Thanks to @fredrikekre for answering the issue on Slack (i.e., no pages).
I guess the potential issues related to this would be:

1. DocumenterTools.generate to automatically include the index.md which has been generated.
2. Address the code such that it doesn't require pages.
3. A better error message.

[kunov]

Hi @Nosferican,

I'm encountering a similar issue, what was the proposed solution again? Thanks

[Nosferican]

Add some pages to it. For example, a "home" => "index.md".

[stefanjwojcik]

I ran into this same issue. The documentation now appears to make clear that you need an index.md file in docs/src for the julia make.jl call to run correctly.

[Volker-Weissmann]

I still think a better error message would be nice. Having good docs is one thing, but having good error messages is another.