diff --git a/docs/make.jl b/docs/make.jl new file mode 100644 index 0000000000000000000000000000000000000000..ede59e712d9d18eed01b2fd6edc04c4b92f85146 --- /dev/null +++ b/docs/make.jl @@ -0,0 +1,3 @@ +using Documenter, CaosDB + +makedocs(sitename="CaosDB.jl Documentation") diff --git a/docs/src/index.md b/docs/src/index.md new file mode 100644 index 0000000000000000000000000000000000000000..ac17339b6661eaf8373c50b218f1324ed4c936ef --- /dev/null +++ b/docs/src/index.md @@ -0,0 +1,8 @@ +# CaosDB.jl documentation + +This will be the index of the documentation of the CaosDB Julia client +library. + +```@docs +dummy_func(x) +``` diff --git a/src/CaosDB.jl b/src/CaosDB.jl index e791e20c006045ba748670a06c44f4ac41a4bd5d..341e2caa59323720495eeb7c7328427b6846a223 100644 --- a/src/CaosDB.jl +++ b/src/CaosDB.jl @@ -1,5 +1,12 @@ module CaosDB -greet() = print("Hello World!") +export dummy_func + +""" + dummy_func(x) + +Returns double the number `x` plus `1`. +""" +dummy_func(x) = 2x + 1 end # module