Skip to content

Latest commit

 

History

History
106 lines (64 loc) · 3.23 KB

README.md

File metadata and controls

106 lines (64 loc) · 3.23 KB
Raw

Atelier: crate atelier_describe

Provides the ability to write documentation for Smithy models.

crates.io docs.rs

This crate provides two mechanisms for generating human-readable documentation for a Smithy model using the crate somedoc.

Firstly, the DocumentationWriter structure implements the atelier_core::io::ModelWriter trait and so may be used in the same manner as other model writers. The ModelWriter::new function takes an argument that will denote the format to produce, but provides little other control over the generation. Internally this writer implementation calls the following function.

The function describe_model will produce a somedoc::model::Document instance from a atelier_core::modrel::Model. This instance may then be rendered according to the writers provided by somedoc. This provides complete control over the actual formatting step, and the same generated Document may be written multiple times if required.

Examples

The following demonstrates how to use the describe_model function.

use atelier_core::model::Model;
use atelier_describe::describe_model;
use somedoc::write::{write_document_to_string, OutputFormat};

let model = make_model();

let documentation = describe_model(&model).unwrap();

let doc_string = write_document_to_string(&documentation, OutputFormat::Html).unwrap();

The following example demonstrates the ModelWriter trait and outputs the documentation, in CommonMark format, to stdout.

use atelier_core::model::Model;
use atelier_core::io::ModelWriter;
use atelier_describe::DocumentationWriter;
use std::io::stdout;

let model = make_model();

let mut writer = DocumentationWriter::default();

let documentation = writer.write(&mut stdout(), &model).unwrap();

Changes

Version 0.1.10

  • Added usage of HasIdentity trait for member shapes.

Version 0.1.9

  • Changed the ID on MemberShape from ShapeID to Identifier. This matches both the formal BNF for the Smithy IDL and the JSON AST usage.

Version 0.1.8

  • Completed trait tables for all shapes/members.
  • Added some additional formatting to indent member definitions.

Version 0.1.7

  • Support the "renames" collection added to service shapes in the abstract model.

Version 0.1.6

  • Supporting the core model builders which now use TryFrom instead of From.
  • Using new shared atelier-test crate.

Version 0.1.5

  • Refactored to have a similar structure to other reader/writer crates.
  • Moved GraphML and PlantUML into this crate from lib.

Version 0.1.4

  • Updated due to trait API changes in core.

Version 0.1.3

  • Refactored DocumentationWriter so that it only emits CommonMark, more closely aligned with Smithy IDL.

Version 0.1.1

  • Fixed: bumped somedoc dependency version.

Version 0.1.1

  • Fixed: removed local path dependency for somedoc.

Version 0.1.0

This initial version is reasonably usable, although incomplete.

TODO

  1. Complete both prelude, and custom, trait output.
  2. Test cases.