diff --git a/CHANGES.rst b/CHANGES.rst index 84980018..2e74da9e 100644 --- a/CHANGES.rst +++ b/CHANGES.rst @@ -68,9 +68,11 @@ Unreleased ---------- - Implement support of `Markdown `_ using js based parser - Update versions: + - Drop python 3.8 - Add python 3.13 - Drop pytest<5.2 + - Added dummy html reporter - Fixed pytest.ini option "disable_feature_autoload" - Improved fixture injection by adding seamless fixtures on plugin/module collection diff --git a/README.rst b/README.rst index 03cf1df2..aed9c850 100644 --- a/README.rst +++ b/README.rst @@ -93,14 +93,14 @@ Install pytest-bdd-ng pip install pytest-bdd-ng -Install extra packages for parsing Markdown defined features -############################################################ +Packages for parsing Markdown defined features +############################################## .. code-block:: console npm install @cucumber/gherkin -Install extra packages for reporting +Packages for reporting #################################### .. code-block:: console @@ -108,6 +108,36 @@ Install extra packages for reporting npm install @cucumber/html-formatter +TLDR; +----- + +.. code-block:: gherkin + + Feature: Simplest example + Scenario: + # https://cucumber.io/docs/gherkin/reference/ + Given File "Passing.feature" with content: + """gherkin + Feature: Passing feature + Scenario: Passing scenario + * Passing step + """ + # https://docs.pytest.org/en/stable/reference/fixtures.html#conftest-py-sharing-fixtures-across-multiple-files + And File "conftest.py" with content: + """python + from pytest_bdd import step + + @step('Passing step') + def _(): + ... + """ + # https://docs.pytest.org/en/stable/how-to/usage.html + When run pytest + Then pytest outcome must contain tests with statuses: + |passed| + | 1| + + Project layout -------------- **pytest-bdd-ng** automatically collects ``*.feature`` files from pytest_ tests directory. diff --git a/docs/include.rst b/docs/include.rst index 199589a6..2d5cf899 100644 --- a/docs/include.rst +++ b/docs/include.rst @@ -2,5 +2,5 @@ .. include:: features.rst .. include:: ../DOCUMENTATION.rst .. include:: ../AUTHORS.rst -.. include:: ../CHANGES.rst .. include:: ../LICENSE.rst +.. include:: ../CHANGES.rst