Skip to main content

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]

Metadata

Release files for sphinxcontrib-robotframework 0.8.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for sphinxcontrib-robotframework 0.8.1
File Size Uploaded
sphinxcontrib-robotframework-0.8.1.tar.gz 5.1 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for sphinxcontrib-robotframework 0.8.1
File Interpreter ABI Platform
sphinxcontrib_robotframework-0.8.1-py2.py3-none-any.whl Python 3, Python 2 none any Details

Total release size: 10.2 kB

Release files / sphinxcontrib-robotframework-0.8.1.tar.gz

Download URL sphinxcontrib-robotframework-0.8.1.tar.gz
Size 5.1 kB
Tags Source
SHA-256 checksum
How to use checksums
02b790a6ec186f9a376b8046628c1ca646dc49c60733579c525e210b7928c06b
BLAKE2b-256 checksum
How to use checksums
78cbeea361cac1c7ff49034ddb2b268c838688d3408a345e06f6ba22cd736b9c
Upload date
Uploaded using Trusted Publishing?
What is 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

Release files / sphinxcontrib_robotframework-0.8.1-py2.py3-none-any.whl

Download URL sphinxcontrib_robotframework-0.8.1-py2.py3-none-any.whl
Size 5.0 kB
Tags Python 2 Python 3
SHA-256 checksum
How to use checksums
f0fdd831e484b68d0b6998512b7fbe9591dc5fc96c8b2de05c29d58a83299628
BLAKE2b-256 checksum
How to use checksums
8f0062c757ea2d4bf6d644ccf02e52ac84c3307359090266538809f4f88e9deb
Upload date
Uploaded using Trusted Publishing?
What is 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

Release history Release notifications | RSS feed

This release

0.8.1 This release

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.1

1 release file

0.6.0

1 release file

0.5.1

1 release file

0.5.0

1 release file

0.4.4

1 release file

0.4.3

1 release file

0.4.2

1 release file

0.4.1

1 release file

0.4.0

1 release file

0.3.1

1 release file

0.3.0

1 release file

0.2.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page