Merge remote-tracking branch 'origin/main' into main

This commit is contained in:
Marco Oesting 2023-10-11 10:31:09 +02:00
commit 1d923dad6a
2 changed files with 39 additions and 5 deletions

21
LICENSE Normal file
View File

@ -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.

View File

@ -10,19 +10,32 @@
``` ```
docs/ docs/
├── src/ ├── src/
├── src/mydocs.jl ├── src/index.md
└── make.jl └── make.jl
``` ```
### add some docs ### add some docs
2. with mydocs containing 2. with mydocs containing
````@docs
func(x)
```` ````
(but with three `)
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 and