Documentation Anchor

Overview

The third category of Anchors is documentation anchors. These can be used to create single-line documentation in the format # @doc #Markdown or to create multi-line documentation using @blockdoc after the first three triple quotes to start a docstring. Documentation anchors can be placed anywhere, and they support plain text, markdown, LaTeX, user-defined fields, and even in-line evaluated Python expressions.

All Documentation Anchors

Anchor

Use

Example

@doc #Header

Creates a documentation card from a single line

# @doc #Header

@blockdoc

Creates a documentation card from a triple quote block

'''@blockdoc
#Header
## Subheader
'''

Single-line Documentation

You can create single-line documentation using the anchor # @doc followed by your documentation itself . Note, two sequential @doc anchors will merge to form a single larger piece of documentation.

Here is a basic example of using a documentation anchor to create a simple markdown heading

# @doc #New Doc
# @doc ##Subheading
# @doc This is some sample text

This would produce the following output:

672672

Multi-line Documentation

You can create multi-line documentation by using the anchor @blockdoc after starting a docstring.

Here is a basic example of using a documentation anchor to create a simple markdown heading

''' @blockdoc
# New Doc
# @doc ##Subheading
# @doc This is some sample text
'''
672672

Special Inline Documentation Features

Artemis supports the following special in-line documentation expressions:

These in-line expressions offer power capabilities ranging from custom code formatting to macros to embedded code snippets.


Did this page help you?