Skip to content

Commit

Permalink
Merge 777d24e into 60cadc5
Browse files Browse the repository at this point in the history
  • Loading branch information
ahojukka5 committed Jan 19, 2018
2 parents 60cadc5 + 777d24e commit fe707ce
Show file tree
Hide file tree
Showing 13 changed files with 1,849 additions and 903 deletions.
37 changes: 21 additions & 16 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -5,25 +5,30 @@ using Documenter, FEMBase

cp("../README.md", "src/index.md"; remove_destination=true)

#=
if haskey(ENV, "TRAVIS")
println("inside TRAVIS, installing PyPlot + matplotlib")
Pkg.add("PyPlot")
run(`pip install matplotlib`)
end
=#
DEVELOPER_GUIDE = [
"mesh.md",
"fields.md",
"basis.md",
"integration.md",
"elements.md",
"problems.md",
"solvers.md",
"postprocessing.md",
"results.md",
"materials.md"]

LIBRARY = ["api.md"]

PAGES = [
"Home" => "index.md",
"Developing JuliaFEM" => DEVELOPER_GUIDE,
"Library" => LIBRARY
]

makedocs(modules=[FEMBase],
format = :html,
checkdocs = :all,
sitename = "FEMBase.jl",
authors = "Jukka Aho",
pages = [
"Introduction" => "index.md",
"Fields" => "fields.md",
"Basis functions" => "basis.md",
"Elements" => "elements.md",
# "Mass matrices" => "mass_matrix.md",
"Developing" => "developing.md",
"API" => "api.md"
])
analytics = "UA-83590644-1",
pages = PAGES)
24 changes: 14 additions & 10 deletions docs/src/api.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,23 @@
# API documentation

## Index

```@index
```
# API Documentation

```@meta
CurrentModule = FEMBase
DocTestSetup = quote
using FEMBase
using FEMBasis
using FEMQuad
end
```

```@autodocs
Modules = [FEMBase, FEMBasis, FEMQuad]
## Fields


## Elements

```@docs
interpolate(element::Element, field_name::String, time::Float64)
```

## Problems

```@docs
assemble_elements!
```

0 comments on commit fe707ce

Please sign in to comment.