-
Notifications
You must be signed in to change notification settings - Fork 10
/
pyproject.toml
50 lines (45 loc) · 2.65 KB
/
pyproject.toml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
[tool.poetry]
name = "sphinx_gherkindoc"
version = "3.6.4"
description = "A tool to convert Gherkin into Sphinx documentation"
authors = ["Lewis Franklin <[email protected]>", "Doug Philips <[email protected]>"]
readme = "README.rst"
homepage = "https://jolly-good-toolbelt.github.io/sphinx_gherkindoc/"
documentation = "https://jolly-good-toolbelt.github.io/sphinx_gherkindoc/"
repository = "https://github.com/jolly-good-toolbelt/sphinx_gherkindoc"
license = "MIT"
[tool.poetry.dependencies]
python = "^3.6.1"
Sphinx = ">=1.3"
sphinx_rtd_theme = ">=0.3.1"
behave = ">=1.2.6"
recommonmark = ">=0.4.0"
typing_extensions = { version = "^3.7.4", python = "<3.8" }
[tool.poetry.dev-dependencies]
sphinx-autodoc-typehints = "^1.6"
# branch: scenario-descriptions
# This branch is still active, so we lock to a specific commit in the branch
# to prevent unexpected issues if that branch is pushed to.
pytest-bdd = {git = "https://github.com/rbcasperson/pytest-bdd.git", rev = "b3d464bef1af2accbef493c6be85fc6232c318ed"}
pytest-cov = "^2.7"
jgt_tools = {version = "^0.5", extras = [ "env_setup", "run_tests" ]}
[tool.poetry.scripts]
sphinx-gherkindoc = 'sphinx_gherkindoc.cli:main'
sphinx-gherkinconfig = 'sphinx_gherkindoc.cli:config'
[build-system]
requires = ["poetry>=0.12"]
build-backend = "poetry.masonry.api"
[tool.jgt_tools]
build_docs_commands = [
"echo 'Building {PACKAGE_NAME} docs'",
"find . -maxdepth 1 -name \\*.rst -exec cp {{}} {DOCS_WORKING_DIRECTORY} \\;",
"cp {BASE_DIR}/.jgt_tools.index {BASE_DIR}/{DOCS_WORKING_DIRECTORY}/index.rst",
"poetry run sphinx-apidoc --output-dir {DOCS_WORKING_DIRECTORY} --no-toc --force --module-first {PACKAGE_NAME} '*sample-conf*'",
"poetry run sphinx-gherkindoc --doc-project 'Sample Gherkin' --toc-name sample-gherkindoc --step-glossary-name sample-gherkindoc-glossary --parser pytest_bdd --raw-descriptions tests {DOCS_WORKING_DIRECTORY}",
"poetry run sphinx-gherkindoc --doc-project 'Sample Gherkin With Integrated Background' --toc-name sample-gherkindoc-integrated-background-default tests_for_integrated_background/default_format {DOCS_WORKING_DIRECTORY} --integrate-background",
"poetry run sphinx-gherkindoc --doc-project 'Sample Gherkin With Integrated Background And A Unique Background Step Format' --toc-name sample-gherkindoc-integrated-background-unique-format tests_for_integrated_background/unique_format {DOCS_WORKING_DIRECTORY} --integrate-background --background-step-format '{{}} *(Background)*'",
"poetry run sphinx-build -c {DOCS_WORKING_DIRECTORY} -aEW {DOCS_WORKING_DIRECTORY} {DOCS_OUTPUT_DIRECTORY}"
]
run_tests_commands = [
"poetry run pytest -vv --cov sphinx_gherkindoc --cov-report term-missing"
]