mirror of
https://github.com/JuliaFEM/JuliaFEM.jl.git
synced 2026-09-18 09:41:31 +00:00
basic doc + @autodoc functions
This commit is contained in:
@@ -0,0 +1,17 @@
|
||||
# API documentation
|
||||
|
||||
## Index
|
||||
|
||||
```@index
|
||||
```
|
||||
|
||||
```@meta
|
||||
DocTestSetup = quote
|
||||
using JuliaFEM
|
||||
end
|
||||
```
|
||||
|
||||
```@autodocs
|
||||
Modules = [JuliaFEM]
|
||||
```
|
||||
|
||||
+25
-17
@@ -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.
|
||||
|
||||
Reference in New Issue
Block a user