Gallery
Table
Code:
```@eval
using DocumentationOverview
DocumentationOverview.table_md(DocumentationOverview)
```
Output:
API | Summary |
---|---|
DocumentationOverview.API | An object passed to include callback of table . |
DocumentationOverview.find(module::Module; [include]) -> apis::Vector{<:API} | List APIs in module . |
DocumentationOverview.list(module::Module; ...) -> list | Show the list of APIs. |
DocumentationOverview.list_md(args...; options...) -> md::Markdown.MD | A shorthand for Markdown.MD(DocumentationOverview.list(args...; options...)) . |
DocumentationOverview.table(module::Module; ...) -> table | Show the table of APIs. |
DocumentationOverview.table_md(args...; options...) -> md::Markdown.MD | A shorthand for Markdown.MD(DocumentationOverview.table(args...; options...)) . |
Table with signature = :strip_namespace
Code:
```@eval
using DocumentationOverview
DocumentationOverview.table_md(
DocumentationOverview;
signature = :strip_namespace,
)
```
Output:
API | Summary |
---|---|
API | An object passed to include callback of table . |
find(module::Module; [include]) -> apis::Vector{<:API} | List APIs in module . |
list(module::Module; ...) -> list | Show the list of APIs. |
list_md(args...; options...) -> md::Markdown.MD | A shorthand for Markdown.MD(DocumentationOverview.list(args...; options...)) . |
table(module::Module; ...) -> table | Show the table of APIs. |
table_md(args...; options...) -> md::Markdown.MD | A shorthand for Markdown.MD(DocumentationOverview.table(args...; options...)) . |
Table with signature = :name
Code:
```@eval
using DocumentationOverview
DocumentationOverview.table_md(
DocumentationOverview;
signature = :name,
)
```
Output:
API | Summary |
---|---|
API | An object passed to include callback of table . |
find | List APIs in module . |
list | Show the list of APIs. |
list_md | A shorthand for Markdown.MD(DocumentationOverview.list(args...; options...)) . |
table | Show the table of APIs. |
table_md | A shorthand for Markdown.MD(DocumentationOverview.table(args...; options...)) . |
List
Code:
```@eval
using DocumentationOverview
DocumentationOverview.list_md(
DocumentationOverview;
)
```
Output:
DocumentationOverview.API
: An object passed toinclude
callback oftable
.DocumentationOverview.find(module::Module; [include]) -> apis::Vector{<:API}
: List APIs inmodule
.DocumentationOverview.list(module::Module; ...) -> list
: Show the list of APIs.DocumentationOverview.list_md(args...; options...) -> md::Markdown.MD
: A shorthand forMarkdown.MD(DocumentationOverview.list(args...; options...))
.DocumentationOverview.table(module::Module; ...) -> table
: Show the table of APIs.DocumentationOverview.table_md(args...; options...) -> md::Markdown.MD
: A shorthand forMarkdown.MD(DocumentationOverview.table(args...; options...))
.