https://github.com/tkf/externaldocstrings.jl

https://github.com/tkf/externaldocstrings.jl

Last synced: 9 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/tkf/externaldocstrings.jl
• Owner: tkf
• License: mit
• Created: 2022-03-20T06:57:50.000Z (almost 4 years ago)
• Default Branch: main
• Last Pushed: 2022-04-13T12:49:11.000Z (over 3 years ago)
• Last Synced: 2025-04-05T22:47:33.028Z (9 months ago)
• Language: Julia
• Size: 143 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# ExternalDocstrings

[![Dev](https://img.shields.io/badge/docs-dev-blue.svg)](https://tkf.github.io/ExternalDocstrings.jl/dev)

[![CI](https://github.com/tkf/ExternalDocstrings.jl/actions/workflows/test.yml/badge.svg)](https://github.com/tkf/ExternalDocstrings.jl/actions/workflows/test.yml)

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

See the [documentation](https://tkf.github.io/ExternalDocstrings.jl/dev) 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:

```julia

ExternalDocstrings.@define_docstrings

```

It defines a docstring for name `MyPackage.$name` using the markdown content in

`src/docs/$name.md`.