diff --git a/docs/build_api.jl b/docs/build_api.jl index 8834c90..f8b04c3 100644 --- a/docs/build_api.jl +++ b/docs/build_api.jl @@ -41,58 +41,14 @@ const modules = append_list # run(`cp $main_folder/$file_ $this_folder`) 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 # 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)) - end - save(joinpath(api_directory, "index.md"), index; md_subheader = :category) - - # 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. - """) + Lexicon.update!(index, save(joinpath(api_directory, "$(mod).rst"), mod)) end + save(joinpath(api_directory, "index.rst"), index; md_subheader = :category) # info("Adding all documentation changes in $(api_directory) to this commit.") # success(`git add $(api_directory)`) || exit(1) end - -# point of this? -#cd(dirname(dirname(@__FILE__))) do -# yaml = """ -# # This is automatically generated by docs/build.jl. Edit that file if you -# # wish to make any permenant changes. -# site_name: JuliaFEM.jl -# site_description: JuliaFEM.jl, open-source software for reliable, scalable, distributed Finite Element Method. -# repo_name: GitHub -# # docs_dir: 'docs' -# # site_dir: 'site' -# repo_url: https://github.com/JuliaFEM/JuliaFEM.jl -# pages: -# - Home: 'index.md' -# #- API Docs: -# - JuliaFEM: 'api/JuliaFEM.md' -# - JuliaFEM.elasticity_solver: 'api/JuliaFEM.elasticity_solver.md' -# theme: readthedocs -# """ -# -# # TODO: add the solutions if I figure out how to get them to render properly -# -# open("mkdocs.yml", "w") do f -# write(f, yaml) -# end -#end -