Skip to content

Commit

Permalink
Simplified documentation generation
Browse files Browse the repository at this point in the history
- README.md is now copied to src/index.md (same content)
- add docs/src/index.md to .gitignore
- export jacobian function
  • Loading branch information
ahojukka5 committed Dec 28, 2017
1 parent e40d670 commit 049ef88
Show file tree
Hide file tree
Showing 6 changed files with 12 additions and 164 deletions.
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@ docs/build/
docs/site/
*.cov
*.swp
docs/src/index.md
11 changes: 5 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,10 @@
# FEMBasis.jl

[![Build Status](https://travis-ci.org/JuliaFEM/FEMBasis.jl.svg?branch=master)](https://travis-ci.org/JuliaFEM/FEMBasis.jl)[![Coverage Status](https://coveralls.io/repos/github/JuliaFEM/FEMBasis.jl/badge.svg?branch=master)](https://coveralls.io/github/JuliaFEM/FEMBasis.jl?branch=master)[![](https://img.shields.io/badge/docs-stable-blue.svg)](https://juliafem.github.io/FEMBasis.jl/stable)[![](https://img.shields.io/badge/docs-latest-blue.svg)](https://juliafem.github.io/FEMBasis.jl/latest)[![Issues](https://img.shields.io/github/issues/JuliaFEM/FEMBasis.jl.svg)](https://github.com/JuliaFEM/FEMBasis.jl/issues)

Package contains interpolation routines for standard finite element function spaces.
Given ansatz and coordinates of domain, interpolation functions are calculated
symbolically in a very general way to get efficient code. As a concrete example,
to evaluate basis functions for standard tetrahedron we write
`FEMBasis.jl` contains interpolation routines for standard finite element
function spaces. Given ansatz and coordinates of domain, interpolation
functions are calculated symbolically in a very general way to get efficient
code. As a concrete example, to generate basis functions for a standard 10-node
tetrahedron one can write

```julia
code = create_basis(
Expand Down
8 changes: 5 additions & 3 deletions docs/make.jl
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,13 @@

using Documenter, FEMBasis

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

makedocs(modules=[FEMBasis],
format = :html,
sitename = "FEMBasis",
checkdocs = :all,
sitename = "FEMBasis.jl",
pages = [
"Introduction" => "index.md",
"Theory" => "theory.md",
"API" => "api.md",
"API documentation" => "api.md",
])
5 changes: 0 additions & 5 deletions docs/src/api.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# API documentation

## Index

```@index
```

```@meta
DocTestSetup = quote
using FEMBasis
using FEMBasis: jacobian
end
```

Expand Down
149 changes: 0 additions & 149 deletions docs/src/index.md

This file was deleted.

2 changes: 1 addition & 1 deletion src/FEMBasis.jl
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ include("nurbs_solid.jl")
export NSolid

include("math.jl")
export interpolate, interpolate!
export interpolate, interpolate!, jacobian
export grad, grad!
export BasisInfo

Expand Down

0 comments on commit 049ef88

Please sign in to comment.