Open montyvesselinov opened 8 years ago
String interpolation should get you what you want here. You can do it with something like
"""
$(readall(joinpath(dirname(@__FILE__), "..", "file1.md")))
$(readall(joinpath(dirname(@__FILE__), "..", "file2.md")))
"""
function test()
end
This is great. It works!
Are there easy ways to list function methods in the documentations?
Are there easy ways to list function methods in the documentations?
I'm not 100% sure exactly what you're after here. Could you give an example of what you'd like to be able to do? Thanks.
Do you mean automatically generating external docs from inline docstrings? If that's the case, then the current work going into https://github.com/MichaelHatherly/Lapidary.jl, which makes use of the new docsystem in Julia 0.4 would probably be of interest. (Note that the Docile/Lexicon combination for generating docs is going to be deprecated (in Julia 0.4/0.5) in favour of Lapidary.jl once it's reached feature parity, which it's very close to doing.)
Are there any plans to add a feature that allows Markdown files to be included in the doc generation.
I would like to be able to do:
""" ../file1.md
../file2.md """ function test() end
where the documentation is generated from external files.