/ExternalDocstrings.jl

Primary LanguageJuliaMIT LicenseMIT

ExternalDocstrings

Dev CI

ExternalDocstrings.jl is a helper for writing docstrings in markdown files.

See the documentation for more information.

Usage

Create markdown files in src/docs/ (where src/MyPackage.jl is the main package source file). Put the following line inside of MyPackage namespace:

ExternalDocstrings.@define_docstrings

It defines a docstring for name MyPackage.$name using the markdown content in src/docs/$name.md.