-
Notifications
You must be signed in to change notification settings - Fork 0
/
pyproject.toml
104 lines (86 loc) · 2.89 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
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
[tool.poetry]
name = "docs_as_code_demo"
version = "0.0.1"
description = "Docs As Code Demo for the EPD 2023 Breakout Session"
authors = ["markus braun <markus.braun@em.ag>"]
maintainers = ["markus braun <markus.braun@em.ag>"]
license = "MIT"
homepage = "https://www.github.com/engineering-methods/docs-as-code-demo"
repository = "https://www.github.com/engineering-methods/docs-as-code-demo"
documentation = "https://www.github.com/engineering-methods/docs-as-code-demo"
readme = "README.md"
[tool.poetry.dependencies]
python = ">=3.8,<3.12"
[tool.poetry.group.docs.dependencies]
sphinx = "^6"
pillow = "^9.5.0"
myst-parser = "^1.0.0"
sphinxcontrib-plantuml = "^0.25"
sphinx-toolbox = "^3.4.0"
sphinx-autoapi = "^2.1.0"
sphinx-copybutton = "^0.5.2"
sphinx-design = "^0.4.1"
sphinx-book-theme = "^1.0.1"
doxysphinx = "^3.3.3"
sphinx-needs = "^1.2.2"
esbonio = "0.15.0"
sphinxcontrib-jquery = "^4.1"
[tool.poetry.group.ci]
optional = true
[tool.poetry.group.ci.dependencies]
poethepoet = "^0.20.0"
[tool.commitizen]
name = "cz_conventional_commits"
version = "0.0.1"
tag_format = "v$version"
version_files = [
"pyproject.toml:^version",
"em/docs_as_code_demo/__init__.py:^__version__",
]
bump_message = """chore(release): release $current_version → $new_version by commitizen [skip-ci]
Signed-off-by: github-actions <actions@github.com>
"""
[build-system]
requires = ["poetry-core"]
build-backend = "poetry.core.masonry.api"
[tool.pytest.ini_options]
log_level = "DEBUG"
testpaths = ["tests"]
junit_logging = "out-err"
markers = ["speed: manual speed tests"]
addopts = "-m 'not speed'"
[tool.black]
line-length = 120
target-version = ['py38']
# black doesn't need further excludes because it honors the .gitignore file
extend-exclude = "(docs/)|(\\.vscode)|(\\.idea)|(\\.devcontainer)"
[tool.isort]
profile = "black"
[tool.poe.tasks.doxygen]
help = "generates the doxygen documentation to docs/doxygen."
cmd = "doxygen src/demo.doxyfile"
[tool.poe.tasks.doxysphinx]
help = "generates rsts out of the doxygen documentation."
cmd = "doxysphinx --verbosity=DEBUG build . .build/html src/demo.doxyfile"
[tool.poe.tasks.sphinx]
help = "generate the documentation html to .build/ directory"
cmd = "sphinx-build -M html . .build -j 'auto' --keep-going"
[tool.poe.tasks.docs]
help = "builds the full documentation in sequence: doxygen, doxysphinx, sphinx"
cmd = "sphinx-build -M html . .build -j 'auto' --keep-going"
deps = ["doxygen", "doxysphinx", "sphinx"]
[tool.poe.tasks.build]
help = "build package into dist/ directory"
cmd = "poetry build"
[tool.poe.tasks.clean]
help = "cleans the .build and dist directories"
cmd = "rm -rf .build/ dist/ && echo cleaned!"
[tool.poe.tasks.lint]
help = "runs all linting/qa tasks over all files"
cmd = "pre-commit run --all-files"
[tool.poe.tasks.test]
help = "runs all pytest unit-tests"
cmd = "pytest"
[tool.poe.tasks.cover]
help = "runs all pytest unit-tests with coverage"
cmd = "pytest --cov"