Rework injecting of markdown files into rst #2

elchupanebrej · Nov 24, 2024 · 70adce3 · 70adce3
1 parent 606fd89
commit 70adce3
Show file tree

Hide file tree

Showing 63 changed files with 3,227 additions and 3,728 deletions.
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -1,6 +1,8 @@
 # See https://pre-commit.com for more information
 # See https://pre-commit.com/hooks.html for more hooks
 ---
+default_language_version:
+  python: python3.12
 repos:
   - repo: https://github.com/psf/black
     rev: 24.10.0
@@ -19,7 +21,9 @@ repos:
     rev: v5.0.0
     hooks:
       - id: trailing-whitespace
+        exclude: "^.*\\.rst$"
       - id: end-of-file-fixer
+        exclude: "^.*\\.rst$"
       - id: check-yaml
       - id: check-added-large-files
       - id: check-toml
@@ -60,4 +64,9 @@ repos:
         language: python
         types: [python]
         pass_filenames: false
-        additional_dependencies: ['docopt-ng', 'pycmarkgfm']
+        additional_dependencies:
+          - 'docopt-ng'
+          - 'pandoc'
+          - 'panflute'
+          - 'pycmarkgfm'
+          - 'pypandoc'
diff --git a/docs/conf.py b/docs/conf.py
@@ -131,6 +131,9 @@
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
 html_static_path = ["_static"]
+html_css_files = [
+    "css/custom.css",
+]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.

diff --git a/docs/features.rst b/docs/features.rst
diff --git a/docs/features/Feature/Description.feature.html b/docs/features/Feature/Description.feature.html
diff --git a/docs/features/Feature/Description.feature.rst b/docs/features/Feature/Description.feature.rst
@@ -0,0 +1,40 @@
+Feature: Descriptions
+^^^^^^^^^^^^^^^^^^^^^
+
+Free-form descriptions can be placed underneath Feature,
+Example/Scenario, Background, Scenario Outline and Rule. You can write
+anything you like, as long as no line starts with a keyword.
+Descriptions can be in the form of Markdown - formatters including the
+official HTML formatter support this.
+
+Scenario:
+'''''''''
+
+- Given File "Description.feature" with content:
+
+  .. code:: gherkin
+
+     Feature:
+       My Feature description
+       Scenario:
+         Given I check feature description
+
+- And File "conftest.py" with content:
+
+  .. code:: python
+
+     from pytest_bdd import given
+
+     @given('I check feature description')
+     def step(feature):
+       assert feature.description == "My Feature description"
+
+- When run pytest
+
+- Then pytest outcome must contain tests with statuses:
+
+  ====== ======
+  passed failed
+  ====== ======
+  1      0
+  ====== ======