Skip to main content

Include documentation from Robot Framework test suites and resource files

Project description

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.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.

Project details


Release history Release notifications

History Node

0.10.0

History Node

0.9.1

History Node

0.9.0

History Node

0.8.0

History Node

0.7.4

History Node

0.7.3

History Node

0.7.2

History Node

0.7.1

History Node

0.7.0

History Node

0.6.0

History Node

0.5.1

History Node

0.5.0

History Node

0.4.1

History Node

0.4.0

History Node

0.3.4

History Node

0.3.3

History Node

0.3.2

History Node

0.3.1

This version
History Node

0.3.0

History Node

0.2.0

History Node

0.1.1

History Node

0.1.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
sphinxcontrib-robotdoc-0.3.0.zip (6.4 kB) Copy SHA256 hash SHA256 Source None Oct 18, 2012

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page