-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
893010d
commit 355e245
Showing
1 changed file
with
33 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,34 @@ | ||
# DocstringAsImage.jl | ||
|
||
This package visualizes Julia docstrings for functions with images. | ||
|
||
## Setup | ||
|
||
```sh | ||
$ git clone https://github.com/AtelierArith/DocstringAsImage.jl.git | ||
$ cd DocstringAsImage.jl | ||
$ julia --project -e 'using Pkg; Pkg.instantiate()' | ||
$ ls | ||
Manifest.toml Project.toml README.md src | ||
``` | ||
|
||
## Usage | ||
|
||
```julia | ||
$ julia | ||
_ | ||
_ _ _(_)_ | Documentation: https://docs.julialang.org | ||
(_) | (_) (_) | | ||
_ _ _| |_ __ _ | Type "?" for help, "]?" for Pkg help. | ||
| | | | | | |/ _` | | | ||
| | |_| | | | (_| | | Version 1.11.2 (2024-12-01) | ||
_/ |\__'_|_|_|\__'_| | Official https://julialang.org/ release | ||
|__/ | | ||
julia> using DocstringAsImage | ||
julia> @imgdoc exp | ||
julia> using SpecialFunctions: zeta | ||
julia> @imgdoc zeta | ||
julia> using Distributions: Beta | ||
julia> @imgdoc Beta | ||
``` |