sphinxcontrib-robotdoc 0.1.1

Include documentation from Robot Framework test suites and resource files

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.*
      :suite: ../src/my_package/tests/acceptance/my_suite.txt
   
   .. robot_keywords::
      :suite: ../src/my_package/tests/acceptance/my_suite.txt

Changelog

0.1.1 (2012-10-14)

• Fixed parsing of resource-only files for keywords.

0.1.0 (2012-10-14)

• Proof of concept.