Problem in auto-generated documentation with Documenter.jl

documenter
#1

I’m updating my package DiscretePredictors.jl to julia 1.0 from julia 0.6.4.
I fixed all deprecations and is using Documenter.jl for generating documentation.

When the documentation is generated, I found that some function names are misspelled in the documentation when I use Documenter.jl (~0.22)
The difference between old and new documentation pages rendered in HTML is shown below:

Old


Link: https://v-i-s-h.github.io/DiscretePredictors.jl/stable/lib/interface/#get_best_symbol-1

New


Link: https://v-i-s-h.github.io/DiscretePredictors.jl/latest/lib/interface/#get*best*symbol-1

It seems like the problem is a confusion between markdown and actual function.
How can I solve this?

Regards,
v-i-s-h

0 Likes

#2

In this file, you should quote the header names too, eg

# `get_best_symbol`
1 Like

#3

Thanks a lot @Tamas_Papp. I worked :slight_smile: .

0 Likes