Skip to main content

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.

Changelog

0.8.1 (2021-09-11)

  • Fix Python >= 3.8 support [mileo]

0.8.0 (2018-05-11)

  • Release as universal wheel [datakurre]

  • Python 3 syntax support [Siming Yuan]

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]

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-robotframework-0.8.1.tar.gz (5.1 kB view details)

Uploaded Source

Built Distribution

sphinxcontrib_robotframework-0.8.1-py2.py3-none-any.whl (5.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file sphinxcontrib-robotframework-0.8.1.tar.gz.

File metadata

  • Download URL: sphinxcontrib-robotframework-0.8.1.tar.gz
  • Upload date:
  • Size: 5.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1.post20210325 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.10

File hashes

Hashes for sphinxcontrib-robotframework-0.8.1.tar.gz
Algorithm Hash digest
SHA256 02b790a6ec186f9a376b8046628c1ca646dc49c60733579c525e210b7928c06b
MD5 bf30f730b6be9bfd557e5f6ff1f157f5
BLAKE2b-256 78cbeea361cac1c7ff49034ddb2b268c838688d3408a345e06f6ba22cd736b9c

See more details on using hashes here.

File details

Details for the file sphinxcontrib_robotframework-0.8.1-py2.py3-none-any.whl.

File metadata

  • Download URL: sphinxcontrib_robotframework-0.8.1-py2.py3-none-any.whl
  • Upload date:
  • Size: 5.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.24.0 setuptools/47.3.1.post20210325 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.7.10

File hashes

Hashes for sphinxcontrib_robotframework-0.8.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 f0fdd831e484b68d0b6998512b7fbe9591dc5fc96c8b2de05c29d58a83299628
MD5 b8368a7602f29345f22035685b30c5d5
BLAKE2b-256 8f0062c757ea2d4bf6d644ccf02e52ac84c3307359090266538809f4f88e9deb

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