Open fleimgruber opened 3 years ago
I just tried this again with Documenter.jl v1.1.0 and got a slightly different Traceback:
Sir? julia --project=. make.jl
┌ Warning: Unable to determine HTML(edit_link = ...) from remote HEAD branch, defaulting to "master".
│ Calling `git remote` failed with an exception. Set JULIA_DEBUG=Documenter to see the error.
│ Unless this is due to a configuration error, the relevant variable should be set explicitly.
└ @ Documenter C:\Users\LeimgruberF\.julia\packages\Documenter\9kOxY\src\utilities\utilities.jl:711
[ Info: SetupBuildDirectory: setting up build directory.
[ Info: Doctest: running doctests.
┌ Error: MarkdownAST conversion error for a docstring in DWDataReader.
│ This is a bug — please report this on the Documenter issue tracker
│ docstr.data =
│ Dict{Symbol, Any} with 5 entries:
│ :typesig => Union{}
│ :module => DWDataReader
│ :linenumber => 147
│ :binding => DWDataReader.c"DW_CH_XML"
│ :path => "C:\\Users\\LeimgruberF\\.julia\\packages\\CBinding\\PrYH5\\src\\context.jl"
└ @ Documenter C:\Users\LeimgruberF\.julia\packages\Documenter\9kOxY\src\doctests.jl:66
ERROR: LoadError: MethodError: no method matching iterate(::Markdown.Link)
Closest candidates are:
iterate(::Union{LinRange, StepRangeLen}) at range.jl:872
iterate(::Union{LinRange, StepRangeLen}, ::Integer) at range.jl:872
iterate(::T) where T<:Union{Base.KeySet{<:Any, <:Dict}, Base.ValueIterator{<:Dict}} at dict.jl:712
...
Stacktrace:
[1] _convert(nodefn::MarkdownAST.NodeFn{Nothing}, c::MarkdownAST.Paragraph, child_convert_fn::typeof(MarkdownAST._convert_inline), md_children::Markdown.Link)
@ MarkdownAST C:\Users\LeimgruberF\.julia\packages\MarkdownAST\CZtZT\src\stdlib\fromstdlib.jl:33
[2] _convert_block(nodefn::MarkdownAST.NodeFn{Nothing}, block::Markdown.Paragraph)
@ MarkdownAST C:\Users\LeimgruberF\.julia\packages\MarkdownAST\CZtZT\src\stdlib\fromstdlib.jl:40
[3] _convert(nodefn::MarkdownAST.NodeFn{Nothing}, c::MarkdownAST.Document, child_convert_fn::typeof(MarkdownAST._convert_block), md_children::Vector{Any})
@ MarkdownAST C:\Users\LeimgruberF\.julia\packages\MarkdownAST\CZtZT\src\stdlib\fromstdlib.jl:34
[4] convert (repeats 2 times)
@ C:\Users\LeimgruberF\.julia\packages\MarkdownAST\CZtZT\src\stdlib\fromstdlib.jl:23 [inlined]
[5] convert
@ C:\Users\LeimgruberF\.julia\packages\MarkdownAST\CZtZT\src\stdlib\fromstdlib.jl:21 [inlined]
[6] _doctest(docstr::Base.Docs.DocStr, mod::Module, doc::Documenter.Document)
@ Documenter C:\Users\LeimgruberF\.julia\packages\Documenter\9kOxY\src\doctests.jl:64
[7] _doctest(blueprint::Documenter.DocumentBlueprint, doc::Documenter.Document)
@ Documenter C:\Users\LeimgruberF\.julia\packages\Documenter\9kOxY\src\doctests.jl:49
[8] runner(#unused#::Type{Documenter.Builder.Doctest}, doc::Documenter.Document)
@ Documenter C:\Users\LeimgruberF\.julia\packages\Documenter\9kOxY\src\builder_pipeline.jl:209
[9] dispatch(#unused#::Type{Documenter.Builder.DocumentPipeline}, x::Documenter.Document)
@ Documenter.Selectors C:\Users\LeimgruberF\.julia\packages\Documenter\9kOxY\src\utilities\Selectors.jl:170
[10] #79
@ C:\Users\LeimgruberF\.julia\packages\Documenter\9kOxY\src\makedocs.jl:248 [inlined]
[11] withenv(::Documenter.var"#79#81"{Documenter.Document}, ::Pair{String, Nothing}, ::Vararg{Pair{String, Nothing}})
@ Base .\env.jl:172
[12] #78
@ C:\Users\LeimgruberF\.julia\packages\Documenter\9kOxY\src\makedocs.jl:247 [inlined]
[13] cd(f::Documenter.var"#78#80"{Documenter.Document}, dir::String)
@ Base.Filesystem .\file.jl:101
[14] #makedocs#77
@ C:\Users\LeimgruberF\.julia\packages\Documenter\9kOxY\src\makedocs.jl:247 [inlined]
[15] top-level scope
@ C:\Users\LeimgruberF\dev\DWDataReader.jl\docs\make.jl:3
in expression starting at C:\Users\LeimgruberF\dev\DWDataReader.jl\docs\make.jl:3
While developing https://github.com/fleimgruber/DWDataReader.jl and working on the docs, I did
and got the error below.
Documenter
thinks this is a bug, but since the error is apparently on one of the dynamically generated bindings (DWDataReader.DWGetVersion
incontext.jl
) I wanted to ask here about any ideas for this before reporting upstream. Are there other packages using CBinding with Documenter? I saw #16, so I guess there are no best practices yet concerning docs?