CODEWITHSUNDEEP
automated-testsfunctional-testingrestructuredtextrobotframework
Ajay
Ajay

Reputation: 4494

Multiline Documentation in robot framework

I want to document test scenarios, the principle behind the scenarios etc. in robot test case itself. For that the documentation need to support multiline features and formatting. Is there anyway to include documents in some formats like rst such that I will have more formatting power with easy syntax.

Upvotes: 3

Views: 8705

Answers (2)

Bryan Oakley
Bryan Oakley

Reputation: 386342

You can spread documentation across multiple lines, and robot supports some simple markup. For information about the specific markup it supports, see Documentation formatting in the robotframework users guide.

My team uses the pipe-delimited format, and we spread documentation out like this:

| Test Case 1
| | [Documentation]
| | ... | = Example Heading =
| | ... | *bold* _italic_ 
| | ... | Lorem ipsum dolor sit amet, consectetur adipisicing elit,
| | ... | do eiusmod tempor incididunt ut labore et dolore sed magna
| | ... | aliqua. Ut enim ad minim veniam, quis nostrud exercitation 
| | ... | ullamco laboris nisi ut aliquip ex ea commodo consequat.

Upvotes: 11

kontulai
kontulai

Reputation: 876

The Robot Framework user guide goes through the different ways of writing documentation. There is also the testdoc-tool for generating high level documentation based on test cases.

Upvotes: 0

Related Questions