The docs/make.jl script first walks the source hierarchy and uses Literate.markdown to process each Julia source file and write a corresponding markdown file to docs/src.
Those .md files are codefenced with @example blocks. Attemptinig to execute those blocks causes Documenter to fail.
In the documentation for Literate.DEFAULT_CONFIGURATION, the explanations for codefence and execute seem inconsistent in that execute should not be true for Markdown files.
In https://github.com/MarkNahabedian/MattParkerJigsawPuzzleProblem.jl I'm trying to use Literate and Documenter to generate documentation.
The
docs/make.jl
script first walks the source hierarchy and usesLiterate.markdown
to process each Julia source file and write a corresponding markdown file todocs/src
. Those.md
files are codefenced with@example
blocks. Attemptinig to execute those blocks causes Documenter to fail.In the documentation for
Literate.DEFAULT_CONFIGURATION
, the explanations forcodefence
andexecute
seem inconsistent in thatexecute
should not be true for Markdown files.Also, in this function https://github.com/fredrikekre/Literate.jl/blob/90b24681a77ccb2ca6ae453e892f589354319c30/src/Literate.jl#L305 it seems to me that the sense of the conditional is inverted from what it should be -- To use
@example
ifexecute
is true.