sphinxcontrib-robotdoc 0.3.1

Include documentation from Robot Framework test suites and resource files.

Yes, this is under early development and everything, everything, may still change.

Usage

1. Add sphinxcontrib_robotdoc into your configuration (conf.py):

   extensions = [
       "sphinxcontrib_robotdoc",
   ]

2. Include test suites and keywords in your documentation:

   .. robot_tests:: Test title or RegExp.*
      :source: ../src/my_package/tests/acceptance/my_suite.txt
      :tags: bugs, new
   
   .. robot_keywords::
      :source: ../src/my_package/tests/acceptance/my_suite.txt

Changelog

0.3.1 (2012-10-18)

• Refactored to parse test/keyword documentation with docutils.core.publish_string (and append them as raw nodes) instead of trying to parse them into sphinx document tree.

0.3.0 (2012-10-18)

• Added support for inline rst in test and keyword documentations.

• Added support for tags.

• Added alternative source option as an alias for suite option in tests.

• Added alternative source and resource options as an alias for suite option in keywords.

• Fixed to filter comment lines from steps.

0.2.0 (2012-10-14)

• Fixed node adapters to return section instead of topics.

0.1.1 (2012-10-14)

• Fixed parsing of resource-only files for keywords.

0.1.0 (2012-10-14)

• Proof of concept.