sphinx_gherkindoc - A tool to convert Gherkin into Sphinx documentation
3.6.4
Library
sphinx_gherkindoc package
Subpackages
sphinx_gherkindoc.parsers package
Submodules
sphinx_gherkindoc.parsers.base module
sphinx_gherkindoc.parsers.behave module
sphinx_gherkindoc.parsers.pytest_bdd module
Submodules
sphinx_gherkindoc.cli module
sphinx_gherkindoc.files module
sphinx_gherkindoc.glossary module
sphinx_gherkindoc.utils module
sphinx_gherkindoc.writer module
Sample Gherkin
Feature:
Testing Sphinx Writer
Background:
Scenario:
Test a Scenario
Scenario Outline:
Test a Scenario Outline
Examples:
Scenario:
Text and Table Scenario
Scenario:
Normal scenarios with add on steps (And, But)
Scenario:
Indentation is ignored when any step in the scenario has text or a table
Feature:
Testing Sphinx Writer
Examples:
Background:
Scenario:
Test a Scenario
Scenario Outline:
Test a Scenario Outline
Examples:
Scenario:
Text and Table Scenario
Scenario:
Normal scenarios with add on steps (And, But)
Scenario:
Indentation is ignored when any step in the scenario has text or a table
Feature:
Feature:
Descriptions with raw rST
Scenario:
A scenario can be described with rST too
Feature:
Feature:
Something
Feature:
Testing Sphinx Writer
Scenario:
Test a Scenario
Scenario Outline:
Test a Scenario Outline
Examples:
Scenario:
Text and Table Scenario
Scenario:
Normal scenarios with add on steps (And, But)
Scenario:
Indentation is ignored when any step in the scenario has text or a table
Feature:
Testing Sphinx Writer
Background:
Scenario:
Test a Scenario
Feature:
Testing Sphinx Writer
Background:
Scenario:
Test a Scenario
Sample Gherkin With Integrated Background
Default Behavior
Feature:
Integrated Backgrounds
Scenario:
First Scenario
Scenario:
Second Scenario
Unique Background
Feature:
Integrated Backgrounds With Unique Format
Scenario:
First Scenario
Scenario:
Second Scenario
Sample Gherkin Glossary
Maintainers
Maintainer’s Documentation
Top-level scripts:
JGT Tools scripts:
Contributors
sphinx_gherkindoc - A tool to convert Gherkin into Sphinx documentation
»
Index
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
K
|
L
|
M
|
N
|
P
|
R
|
S
|
T
|
V
|
W
A
a
a step with some text
a test feature
add_output() (sphinx_gherkindoc.utils.SphinxWriter method)
add_reference() (sphinx_gherkindoc.glossary.GlossaryEntry method)
all the children are gone
an And step with some text too
another thing happened
apply_role() (in module sphinx_gherkindoc.writer)
B
b
Background (class in sphinx_gherkindoc.parsers.pytest_bdd)
background (sphinx_gherkindoc.parsers.pytest_bdd.Feature property)
BaseModel (class in sphinx_gherkindoc.parsers.base)
BehaveModel (class in sphinx_gherkindoc.parsers.behave)
blank_line() (sphinx_gherkindoc.utils.SphinxWriter method)
C
c
config() (in module sphinx_gherkindoc.cli)
create_section() (sphinx_gherkindoc.utils.SphinxWriter method)
D
description (sphinx_gherkindoc.parsers.behave.BehaveModel property)
(sphinx_gherkindoc.parsers.pytest_bdd.PytestModel property)
dir_path (sphinx_gherkindoc.files.DirData property)
DirData (class in sphinx_gherkindoc.files)
display_name() (in module sphinx_gherkindoc.utils)
doodle-doodle-doodle-doo
E
Encarnaciooooon
Example (class in sphinx_gherkindoc.parsers.pytest_bdd)
examples (sphinx_gherkindoc.parsers.behave.Feature property)
(sphinx_gherkindoc.parsers.FeatureClass attribute)
(sphinx_gherkindoc.parsers.pytest_bdd.Feature property)
(sphinx_gherkindoc.parsers.pytest_bdd.Scenario property)
(sphinx_gherkindoc.parsers.ScenarioClass attribute)
ExamplesTableClass (class in sphinx_gherkindoc.parsers)
exists (sphinx_gherkindoc.parsers.base.BaseModel property)
F
Feature (class in sphinx_gherkindoc.parsers.behave)
(class in sphinx_gherkindoc.parsers.pytest_bdd)
feature_to_rst() (in module sphinx_gherkindoc.writer)
FeatureClass (class in sphinx_gherkindoc.parsers)
filename (sphinx_gherkindoc.parsers.pytest_bdd.Step property)
files (sphinx_gherkindoc.files.DirData property)
G
get_all_included_scenarios() (in module sphinx_gherkindoc.utils)
GlossaryEntry (class in sphinx_gherkindoc.glossary)
H
headings (sphinx_gherkindoc.parsers.pytest_bdd.InlineTable property)
how about a table in there too
I
I put <thing> in a blender
I turn the blender on
InlineTable (class in sphinx_gherkindoc.parsers.pytest_bdd)
is_feature_file() (in module sphinx_gherkindoc.files)
is_rst_file() (in module sphinx_gherkindoc.files)
it should transform into <other thing>
K
keyword (sphinx_gherkindoc.parsers.pytest_bdd.PytestModel property)
(sphinx_gherkindoc.parsers.StepClass attribute)
L
line (sphinx_gherkindoc.parsers.pytest_bdd.Step property)
M
main() (in module sphinx_gherkindoc.cli)
make_flat_name() (in module sphinx_gherkindoc.utils)
make_steps_glossary() (in module sphinx_gherkindoc.glossary)
module
sphinx_gherkindoc
sphinx_gherkindoc.cli
sphinx_gherkindoc.files
sphinx_gherkindoc.glossary
sphinx_gherkindoc.parsers
sphinx_gherkindoc.parsers.base
sphinx_gherkindoc.parsers.behave
sphinx_gherkindoc.parsers.pytest_bdd
sphinx_gherkindoc.utils
sphinx_gherkindoc.writer
N
name (sphinx_gherkindoc.parsers.pytest_bdd.PytestModel property)
(sphinx_gherkindoc.parsers.pytest_bdd.Step property)
(sphinx_gherkindoc.parsers.StepClass attribute)
P
path_list (sphinx_gherkindoc.files.DirData property)
process_args() (in module sphinx_gherkindoc.cli)
PytestModel (class in sphinx_gherkindoc.parsers.pytest_bdd)
R
role_name_from() (in module sphinx_gherkindoc.writer)
rows (sphinx_gherkindoc.parsers.pytest_bdd.InlineTable property)
rst_escape() (in module sphinx_gherkindoc.utils)
S
scan_tree() (in module sphinx_gherkindoc.files)
Scenario (class in sphinx_gherkindoc.parsers.behave)
(class in sphinx_gherkindoc.parsers.pytest_bdd)
ScenarioClass (class in sphinx_gherkindoc.parsers)
scenarios (sphinx_gherkindoc.parsers.behave.Feature property)
(sphinx_gherkindoc.parsers.FeatureClass attribute)
(sphinx_gherkindoc.parsers.pytest_bdd.Feature property)
sections (sphinx_gherkindoc.utils.SphinxWriter attribute)
set_dry_run() (in module sphinx_gherkindoc.utils)
set_verbose() (in module sphinx_gherkindoc.utils)
something
something deep inside me
something else
something else also happened
something happened
something happens
sphinx_gherkindoc
module
sphinx_gherkindoc.cli
module
sphinx_gherkindoc.files
module
sphinx_gherkindoc.glossary
module
sphinx_gherkindoc.parsers
module
sphinx_gherkindoc.parsers.base
module
sphinx_gherkindoc.parsers.behave
module
sphinx_gherkindoc.parsers.pytest_bdd
module
sphinx_gherkindoc.utils
module
sphinx_gherkindoc.writer
module
SphinxWriter (class in sphinx_gherkindoc.utils)
Step (class in sphinx_gherkindoc.parsers.pytest_bdd)
step text
step_type (sphinx_gherkindoc.parsers.pytest_bdd.Step property)
StepClass (class in sphinx_gherkindoc.parsers)
steps (sphinx_gherkindoc.parsers.pytest_bdd.Background property)
(sphinx_gherkindoc.parsers.pytest_bdd.Scenario property)
(sphinx_gherkindoc.parsers.ScenarioClass attribute)
sub_dirs (sphinx_gherkindoc.files.DirData property)
T
table (sphinx_gherkindoc.parsers.pytest_bdd.Example property)
(sphinx_gherkindoc.parsers.pytest_bdd.Step property)
tags (sphinx_gherkindoc.parsers.ExamplesTableClass attribute)
(sphinx_gherkindoc.parsers.FeatureClass attribute)
(sphinx_gherkindoc.parsers.pytest_bdd.Example property)
(sphinx_gherkindoc.parsers.ScenarioClass attribute)
text (sphinx_gherkindoc.parsers.pytest_bdd.Step property)
that this file exists
the fantasy has ended
the file is converted into rST
the suite reaches a scenario
the suite reaches a scenario table
toctree() (in module sphinx_gherkindoc.writer)
tuple_len() (sphinx_gherkindoc.glossary.GlossaryEntry method)
V
verbose() (in module sphinx_gherkindoc.utils)
W
write_to_file() (sphinx_gherkindoc.utils.SphinxWriter method)