diff --git a/material/3_wed/docs/handout.qmd b/material/3_wed/docs/handout.qmd index dd28a7a..122f4ba 100644 --- a/material/3_wed/docs/handout.qmd +++ b/material/3_wed/docs/handout.qmd @@ -1,7 +1,12 @@ - ::: callout [Link to Slides](slides.qmd) ::: + +## Task 1 + +Solve [task 1](tasks.qmd#1) + +---- # Documenter.jl ### File-structure overview @@ -76,6 +81,13 @@ Using `Literate.jl` one does not need to write `.md` files - but rather can use ## this is a comment ``` + +## Task 2 + +Solve [task 2](tasks.qmd#2) + +---- + # PkgTemplate.jl ```julia ]activate --temp @@ -104,4 +116,9 @@ You can also run the PkgTemplate interactively using Template(interactive=true)("MyPkg") ``` Which will ask you a hundred million questions ;-) -::: \ No newline at end of file +::: + + +## Task 3 + +Solve [task 3](tasks.qmd#3) diff --git a/material/3_wed/docs/tasks.qmd b/material/3_wed/docs/tasks.qmd index e69de29..7718968 100644 --- a/material/3_wed/docs/tasks.qmd +++ b/material/3_wed/docs/tasks.qmd @@ -0,0 +1,62 @@ +# Task 1: Docstrings {#1} +1. Add Docstrings to some of your functions. +2. Load the package, and check you can see the docstrings using e.g. `?rse_mean` + +----- + +# Task 2: Documenter.jl {#1} +### Folderstructure +1. create folders/files: +``` +docs/ +├── src/ +├── src/mydocs.jl +└── make.jl +``` + +### add some docs +2. with mydocs containing + +````{verbatim} +```@docs +func(x) +``` +```` + +and + +`make.jl` containing +```julia +using Documenter, Example + +makedocs(sitename="My Documentation") +``` + +### 3. Generate +Generate the docs using `include("make.jl")` after activating the `./docs/Project.toml` + +:::callout +## Bonus-Task + Use [`LiveServer.jl`](https://github.com/tlienart/LiveServer.jl) to automatically update a local preview of your documentation (follow [this tutorial](https://github.com/tlienart/LiveServer.jl#serve-docs) ) +::: + +### 4. Add a tutorial +Now add a tutorial `./docs/src/tutorial.md` which should contain a brief example simulating some data (using `rand`) and calculating mean, tstat and std on them. + +Use the `makedocs(...page=)` keywordargument. + +---- + +# Task 3: PkgTemplate.jl {#3} +Generate a package MySecondStatsPackage using PkgTemplate. + +- Add github-actions for: + - coverage + - unittests + - docs +- MIT license +- README.md + +::: callout-tipp + Don't forget to activate the github-page in the github settings! +::: \ No newline at end of file