Skip to main content

Include documentation from Robot Framework test suites and resource files

Project description

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.0 (2012-10-14)

  • Proof of concept.

Project details


Download files

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

Source Distribution

sphinxcontrib-robotdoc-0.1.0.zip (5.4 kB view details)

Uploaded Source

File details

Details for the file sphinxcontrib-robotdoc-0.1.0.zip.

File metadata

File hashes

Hashes for sphinxcontrib-robotdoc-0.1.0.zip
Algorithm Hash digest
SHA256 8d302a385a50ac172557903377840878e05f0010eb912cdee277bdefe6c24048
MD5 5f1dc773a90f35c14dab3ad50e05ed2d
BLAKE2b-256 dd1e5ccc380790998ecd53ff6b6301b83691ebab9d8714d9a770afd8b4f7432a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page