diff --git a/docs/deploy.jl b/docs/deploy.jl new file mode 100644 index 0000000..b84dfc2 --- /dev/null +++ b/docs/deploy.jl @@ -0,0 +1,11 @@ +# This file is a part of JuliaFEM. +# License is MIT: see https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/LICENSE.md + +using Documenter + +deploydocs( + repo = "github.com/JuliaFEM/JuliaFEM.jl.git", + julia = "0.6", + target = "build", + deps = nothing, + make = nothing) diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000..4e3dd5e --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,18 @@ +# This file is a part of JuliaFEM. +# License is MIT: see https://github.com/JuliaFEM/JuliaFEM.jl/blob/master/LICENSE.md + +using Documenter, JuliaFEM + +if haskey(ENV, "TRAVIS") + println("inside TRAVIS, installing PyPlot + matplotlib") + Pkg.add("PyPlot") + run(`pip install matplotlib`) +end + +makedocs(modules=[JuliaFEM], + format = :html, + sitename = "JuliaFEM", + pages = [ + "Introduction" => "index.md", + "API" => "api.md" + ]) diff --git a/docs/src/api.md b/docs/src/api.md new file mode 100644 index 0000000..0999f5e --- /dev/null +++ b/docs/src/api.md @@ -0,0 +1,17 @@ +# API documentation + +## Index + +```@index +``` + +```@meta +DocTestSetup = quote + using JuliaFEM +end +``` + +```@autodocs +Modules = [JuliaFEM] +``` + diff --git a/docs/src/index.md b/docs/src/index.md index 298dda1..666b9f2 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,27 +1,35 @@ # JuliaFEM.jl documentation ```@contents +Pages = ["index.md", "api.md"] ``` -```@meta -DocTestSetup = quote - using JuliaFEM - using JuliaFEM.Preprocess -end +The JuliaFEM project develops open-source software for reliable, scalable, +distributed Finite Element Method. + +The JuliaFEM software library is a framework that allows for the distributed +processing of large Finite Element Models across clusters of computers using +simple programming models. It is designed to scale up from single servers to +thousands of machines, each offering local computation and storage. The basic +design principle is: everything is nonlinear. All physics models are nonlinear +from which the linearization are made as a special cases. + +## Installing and testing package + +Installing package goes same way like other packages in julia, i.e. +```julia +julia> Pkg.add("JuliaFEM") ``` -## Constants - -Add here. - -## Functions - -```@docs -JuliaFEM.Preprocess.create_surface_elements +Testing package can be done using `Pkg.test`, i.e. +```julia +julia> Pkg.test("JuliaFEM") ``` -## Index - -```@index -``` +## Contributing +Have a new great idea and want to share it with the open source community? +From [here](https://github.com/JuliaLang/julia/blob/master/CONTRIBUTING.md) +and [here](https://juliadocs.github.io/Documenter.jl/stable/man/contributing/) +you can look for coding style. [Here](https://docs.julialang.org/en/stable/manual/packages/#Making-changes-to-an-existing-package-1) is explained how to contribute to +open source project, in general.