This commit is contained in:
ovainola
2015-07-30 20:41:52 +03:00
parent 08077a783a
commit cc54c626ad
3 changed files with 16 additions and 28 deletions
-11
View File
@@ -1,11 +0,0 @@
API Documentation
=================
Automatically generated apidoc comes here.
Contents:
.. toctree::
:maxdepth: 2
JuliaFEM.elasticity_solver.md
+16 -16
View File
@@ -42,28 +42,28 @@ const modules = append_list
cd(dirname(@__FILE__)) do
# Run the doctests *before* we start to generate *any* documentation.
for m in modules
failures = failed(doctest(m))
if !isempty(failures.results)
println("\nDoctests failed, aborting commit.\n")
display(failures)
exit(1) # Bail when doctests fail.
end
end
# for m in modules
# failures = failed(doctest(m))
# if !isempty(failures.results)
# println("\nDoctests failed, aborting commit.\n")
# display(failures)
# exit(1) # Bail when doctests fail.
# end
# end
# Generate and save the contents of docstrings as markdown files.
index = Index()
for mod in modules
Lexicon.update!(index, save(joinpath(api_directory, "$(mod).md"), mod))
Lexicon.update!(index, save(joinpath(api_directory, "$(mod).rst"), mod))
end
save(joinpath(api_directory, "index.md"), index; md_subheader = :category)
#save(joinpath(api_directory, "index.rst"))
# Add a reminder not to edit the generated files.
open(joinpath(api_directory, "README.md"), "w") do f
print(f, """
Files in this directory are generated using the `build.jl` script. Make
all changes to the originating docstrings/files rather than these ones.
""")
end
# open(joinpath(api_directory, "README.md"), "w") do f
# print(f, """
# Files in this directory are generated using the `build.jl` script. Make
# all changes to the originating docstrings/files rather than these ones.
# """)
# end
# info("Adding all documentation changes in $(api_directory) to this commit.")
# success(`git add $(api_directory)`) || exit(1)
-1
View File
@@ -2,7 +2,6 @@
# License is MIT: see https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/LICENSE.md
module JuliaFEM
VERSION < v"0.4-" && using Docile
using Lexicon