mirror of
https://github.com/JuliaFEM/JuliaFEM.jl.git
synced 2026-09-19 01:48:47 +00:00
Jukka Aho
50 lines
1.4 KiB
Julia
50 lines
1.4 KiB
Julia
using Docile, Lexicon, JuliaFEM
|
|
|
|
"""
|
|
Searches recursively all the modules from packages. As documentation grows, it's a bit
|
|
troublesome to add all the new modules manually, so this function searches all the modules
|
|
automatically.
|
|
|
|
Parameters
|
|
----------
|
|
module_: Module
|
|
Module where we want to search modules inside
|
|
append_list: Array{Module, 1}
|
|
Array, where we append Modules as we find them
|
|
|
|
Returns
|
|
-------
|
|
None. Void function, which manipulates the append_list
|
|
"""
|
|
function search_modules!(module_::Module, append_list::Array{Module, 1})
|
|
all_names = names(module_, true)
|
|
for each in all_names
|
|
inner_module = module_.(each)
|
|
if (typeof(inner_module) == Module) && !(inner_module in append_list)
|
|
push!(append_list, inner_module)
|
|
search_modules!(inner_module, append_list)
|
|
end
|
|
end
|
|
end
|
|
|
|
append_list = Array(Module, 0)
|
|
search_modules!(JuliaFEM, append_list)
|
|
|
|
const modules = append_list
|
|
|
|
cd(dirname(@__FILE__)) do
|
|
# Run the doctests *before* we start to generate *any* documentation.
|
|
fid = open("./quality/doctests_report.rst", "w")
|
|
for m in modules
|
|
results = doctest(m)
|
|
write(fid, results)
|
|
#failures = failed(doctest(m))
|
|
#if !isempty(failures.results)
|
|
# println("\nDoctests failed, aborting commit.\n")
|
|
# display(failures)
|
|
# exit(1) # Bail when doctests fail.
|
|
#end
|
|
end
|
|
close(fid)
|
|
end
|