Skip to content
Snippets Groups Projects
Commit 49ee0fd2 authored by florian's avatar florian
Browse files

DOC: Add @autodocs example

parent 16857c2e
Branches
Tags
No related merge requests found
Pipeline #9515 passed
using Documenter, CaosDB using Documenter, CaosDB
makedocs(sitename="CaosDB.jl Documentation") makedocs(
modules=[CaosDB],
sitename="CaosDB.jl Documentation")
...@@ -3,6 +3,17 @@ ...@@ -3,6 +3,17 @@
This will be the index of the documentation of the CaosDB Julia client This will be the index of the documentation of the CaosDB Julia client
library. library.
Manually add a docstring here:
```@docs ```@docs
dummy_func(x) dummy_func(x)
``` ```
## Semi-auomatic generation of documentation
Similar to autodoc:
```@autodocs
Modules=[CaosDB]
```
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment