Task 1: Docstrings

  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

Folderstructure

  1. create folders/files:
docs/
β”œβ”€β”€ src/
β”œβ”€β”€ src/index.md
└── make.jl

add some docs

  1. with mydocs containing

Show docstring of a single function `func`
```@docs 
func
```

Provide documentation for all doc_string-equiped functions
```@autodocs 
Modules = [MyDocsPackage]
```

Execute a code-block, but hide it's output
```@example MyScope
x = [1,2,3]
nothing #hide
```

and

make.jl containing

using Documenter, Example

makedocs(sitename="My Documentation")

3. Generate

Generate the docs using include("make.jl") after activating the ./docs/Project.toml

Bonus-Task

Use LiveServer.jl to automatically update a local preview of your documentation (follow this tutorial )

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

Generate a package MySecondStatsPackage using PkgTemplate.

  • Add github-actions for:
    • coverage
    • unittests
    • docs
  • MIT license
  • README.md

Don’t forget to activate the github-page in the github settings!