Documentation Tool at a Glance

Artemis Documentation at a Glance

What is Artemis Documentation?

Artemis offers a new documentation system that automagically transforms special in line comments called Anchors into appealing cards that display alongside your code in a detached document we call an Archive. Anchors can be used to render static documentation content that describes your code (Markdown, LaTeX, multimedia) or capture and display runtime artifacts (e.g. extracting and graphing the results of your calculation).

The image below is an example of an Archive. The code on the right is from an Artemis user's project. The comments in that code beginning with the "@" symbol are Anchors and the column on the left displays the static documentation (top) and runtime artifacts (bottom) displayed at the direction of their respective anchors.


How Artemis Documentation Works

Archives are created when you run a script that contains Anchors using our command line utility.

We offer four types of Anchors to create your Archives. Documentation and Output Anchors are used to create static documentation content and capture artifacts generated by your code during runtime and display them in your Archive. Organization and Control Flow Anchors, allow you customize the presentation format of your archives. If you desire capabilities beyond what is offered by these four Anchors, Artemis also allows you to customize the Anchor system to your own needs.

Click on the cards below to learn more about each Anchor type:

Documentation anchors allow you to create static content that explains your code, such as Markdown, LaTeX, multi-media, and more. This is well-suited for explaining your code and giving it context.

Output anchors give you the ability to visualize variables generated at runtime in useful forms, such as tables, text, images, graphs, and more. This is ideal for showcasing code artifacts like datasets, intermediate values, and final results.

Organization anchors give you the ability to organize the content of your Archive into distinct customizable cards. Use organization anchors to label, organize, and group portions of your documentation to make it more readable and digestable.

Control Flow anchors allow you to customize the process of generating archives with custom delays and pauses. This allows you to step through your code's execution as it generate your Archive.

Customizable Anchor Properties allow you to expand on existing Anchors to fill any niche. You can create custom fields, special output types, and more.