From 49ee0fd23c428e33724e51d8f7e425a25ee687dd Mon Sep 17 00:00:00 2001 From: florian <f.spreckelsen@inidscale.com> Date: Wed, 30 Jun 2021 12:08:44 +0200 Subject: [PATCH] DOC: Add @autodocs example --- docs/make.jl | 4 +++- docs/src/index.md | 11 +++++++++++ 2 files changed, 14 insertions(+), 1 deletion(-) diff --git a/docs/make.jl b/docs/make.jl index ede59e7..836b38b 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -1,3 +1,5 @@ using Documenter, CaosDB -makedocs(sitename="CaosDB.jl Documentation") +makedocs( + modules=[CaosDB], + sitename="CaosDB.jl Documentation") diff --git a/docs/src/index.md b/docs/src/index.md index ac17339..ef6b868 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,6 +3,17 @@ This will be the index of the documentation of the CaosDB Julia client library. +Manually add a docstring here: + ```@docs dummy_func(x) ``` + + +## Semi-auomatic generation of documentation + +Similar to autodoc: + +```@autodocs +Modules=[CaosDB] +``` -- GitLab