Skip to main content
This is a pre-production deployment of Warehouse. Changes made here affect the production instance of PyPI (
Help us improve Python packaging - Donate today!

Robot Framework extension for Sphinx

Project Description

Robot Framework extension for Sphinx

sphinxcontrib-robotframework is a Sphinx-extension, which executes embedded Robot Framework tests during sphinx-build.

sphinxcontrib-robotframework can be used in doctest way to validate examples shown in documentation or with Selenium and its Robot Framework integration, Selenium2Library, to generate scripted screenshots during the documentation compiliation time, for CI-generated up-to-date screenshots.

Read the docs for more detailed information.


0.7.0 (2017-10-03)

  • Fix issue where plugin was broken on Sphinx >= 1.5 [datakurre]
  • Fix issue where robot framework test suites without tests were run [datakurre]

0.6.1 (2016-09-25)

  • Fix to provide default value (False) when checking for nitpicky mode. [datakurre]

0.6.0 (2016-09-25)

  • Add support for Sphinx nitpicky-mode.

    When nitpicky mode is enabled, failing Robot Framework test in docs will raise Sphinx error and leave Robot Framework log file into docs src directory. [datakurre]

0.5.1 (2015-07-24)

  • Fix issue where non-ascii characters caused build failures [datakurre]

0.5.0 (2014-12-24)

  • Add to persist log of successfully run Robot Framework tests and to not re-run them until they are changed (or build is cleared). This obsoletes .. robotframework:: :creates: -behavior. [datakurre]

0.4.4 (2014-07-20)

  • Update documentation [datakurre]

0.4.3 (2014-02-10)

  • Add global ‘quiet’ option to drop all robot syntax from sphinx output [datakurre]

0.4.2 (2013-09-30)

  • Fix to keep working with robotframework < 2.8.x [datakurre]

0.4.1 (2013-09-30)

  • Add test suite validation and skip running test suites without test cases [datakurre]

0.4.0 (2013-09-29)

  • Add support for overriding robot variables using ROBOT_-prefixed environment variables [datakurre]

0.3.1 (2013-09-21)

  • Fix issue in Sphinx’s image processing after test has been run [datakurre]

Release History

This version
History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


History Node


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
(6.8 kB) Copy SHA256 Hash SHA256
Wheel py2 Oct 3, 2017
(5.4 kB) Copy SHA256 Hash SHA256
Source None Oct 3, 2017

Supported By

Elastic Elastic Search Pingdom Pingdom Monitoring Dyn Dyn DNS Sentry Sentry Error Logging CloudAMQP CloudAMQP RabbitMQ Heroku Heroku PaaS Kabu Creative Kabu Creative UX & Design Fastly Fastly CDN DigiCert DigiCert EV Certificate Google Google Cloud Servers