From add020ded5348377edb606fa644ed7170c7fec41 Mon Sep 17 00:00:00 2001 From: "behinger (s-ccs 001)" Date: Wed, 11 Oct 2023 08:09:39 +0000 Subject: [PATCH 1/4] fix example backticks --- material/3_wed/docs/tasks.qmd | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/material/3_wed/docs/tasks.qmd b/material/3_wed/docs/tasks.qmd index fb15e70..73384b7 100644 --- a/material/3_wed/docs/tasks.qmd +++ b/material/3_wed/docs/tasks.qmd @@ -17,12 +17,17 @@ docs/ ### add some docs 2. with mydocs containing - -````@docs -func(x) ```` -(but with three `) - +```@docs +func +``` +```@autodocs +``` +```@example MyScope +x = [1,2,3] +nothing #hide +``` +```` and From ae6d91c02d6620e3d40a6e4d25dd9e0d777851c4 Mon Sep 17 00:00:00 2001 From: "behinger (s-ccs 001)" Date: Wed, 11 Oct 2023 08:13:32 +0000 Subject: [PATCH 2/4] fix index.qmd --- material/3_wed/docs/tasks.qmd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/material/3_wed/docs/tasks.qmd b/material/3_wed/docs/tasks.qmd index 73384b7..f1e1c64 100644 --- a/material/3_wed/docs/tasks.qmd +++ b/material/3_wed/docs/tasks.qmd @@ -10,7 +10,7 @@ ``` docs/ ├── src/ -├── src/mydocs.jl +├── src/index.md └── make.jl ``` From a3db9d568db98c06852d987618dff19064089283 Mon Sep 17 00:00:00 2001 From: Benjamin Uekermann Date: Wed, 11 Oct 2023 10:15:08 +0200 Subject: [PATCH 3/4] Create LICENSE (#14) --- LICENSE | 21 +++++++++++++++++++++ 1 file changed, 21 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..8064d6a --- /dev/null +++ b/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2023 s-ccs + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. From db2e8d742d22e79ac4b2a604a6e1b12c3abaeb35 Mon Sep 17 00:00:00 2001 From: "behinger (s-ccs 001)" Date: Wed, 11 Oct 2023 08:19:37 +0000 Subject: [PATCH 4/4] improved tipps --- material/3_wed/docs/tasks.qmd | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/material/3_wed/docs/tasks.qmd b/material/3_wed/docs/tasks.qmd index f1e1c64..005571c 100644 --- a/material/3_wed/docs/tasks.qmd +++ b/material/3_wed/docs/tasks.qmd @@ -18,15 +18,23 @@ docs/ 2. 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