84 lines
2.5 KiB
Plaintext
84 lines
2.5 KiB
Plaintext
{
|
|
"cells": [
|
|
{
|
|
"cell_type": "markdown",
|
|
"metadata": {},
|
|
"source": [
|
|
"# Task 1: Docstrings {#1}\n",
|
|
"1. Add Docstrings to some of your functions.\n",
|
|
"2. Load the package, and check you can see the docstrings using e.g. `?rse_mean`\n",
|
|
"\n",
|
|
"-----\n",
|
|
"\n",
|
|
"# Task 2: Documenter.jl {#1}\n",
|
|
"### Folderstructure\n",
|
|
"1. create folders/files:\n",
|
|
"```\n",
|
|
"docs/\n",
|
|
"├── src/\n",
|
|
"├── src/mydocs.jl\n",
|
|
"└── make.jl\n",
|
|
"```\n",
|
|
"\n",
|
|
"### add some docs\n",
|
|
"2. with mydocs containing\n",
|
|
"\n",
|
|
"\n",
|
|
"````{verbatim}\n",
|
|
"```@docs \n",
|
|
"func(x)\n",
|
|
"```\n",
|
|
"\n",
|
|
"````\n",
|
|
"\n",
|
|
"and\n",
|
|
"\n",
|
|
"`make.jl` containing\n",
|
|
"```julia\n",
|
|
"using Documenter, Example\n",
|
|
"\n",
|
|
"makedocs(sitename=\"My Documentation\")\n",
|
|
"```\n",
|
|
"\n",
|
|
"### 3. Generate\n",
|
|
"Generate the docs using `include(\"make.jl\")` after activating the `./docs/Project.toml`\n",
|
|
"\n",
|
|
":::callout\n",
|
|
"## Bonus-Task\n",
|
|
" 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) )\n",
|
|
":::\n",
|
|
"\n",
|
|
"### 4. Add a tutorial\n",
|
|
"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.\n",
|
|
"\n",
|
|
"Use the `makedocs(...page=)` keywordargument.\n",
|
|
"\n",
|
|
"----\n",
|
|
"\n",
|
|
"# Task 3: PkgTemplate.jl {#3}\n",
|
|
"Generate a package MySecondStatsPackage using PkgTemplate. \n",
|
|
"\n",
|
|
"- Add github-actions for:\n",
|
|
" - coverage\n",
|
|
" - unittests\n",
|
|
" - docs\n",
|
|
"- MIT license\n",
|
|
"- README.md\n",
|
|
"\n",
|
|
"::: callout-tipp\n",
|
|
" Don't forget to activate the github-page in the github settings!\n",
|
|
":::"
|
|
],
|
|
"id": "7ec915e0"
|
|
}
|
|
],
|
|
"metadata": {
|
|
"kernelspec": {
|
|
"name": "python3",
|
|
"language": "python",
|
|
"display_name": "Python 3 (ipykernel)"
|
|
}
|
|
},
|
|
"nbformat": 4,
|
|
"nbformat_minor": 5
|
|
} |