docs/tox.ini at main · AboveHero/docs · GitHub

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
105
106
107
108
109
110
111
112
113
114
115
116
[tox]
envlist = yamllint,flake8,bashate,markdownlint,build

[testenv]
skip_install = True
passenv = DOCS_*
setenv =
  DISABLE_MKDOCS_2_WARNING = true
deps = -rrequirements.txt
commands =
  mkdocs {posargs}
allowlist_externals =
  {toxinidir}/scripts/*

[testenv:mkdocs]

[testenv:serve]
setenv =
  DOCS_SITE_URL = http://localhost:8000
commands =
  mkdocs serve {posargs}

[testenv:mike]
passenv =
  {[testenv]passenv}
  CI_*
  GIT_*
commands =
  {toxinidir}/scripts/run-mike.py {posargs}

[testenv:build]
commands =
  mkdocs build --strict

[testenv:check]
deps =
  {[testenv]deps}
  linkchecker
commands =
  {toxinidir}/scripts/linkcheck-local.sh {posargs}

[testenv:check-prod]
deps =
  linkchecker
commands =
  {toxinidir}/scripts/linkcheck-production.sh {posargs}

[testenv:deploy-github]
passenv =
  {[testenv]passenv}
  GITHUB_*
commands =
  {toxinidir}/scripts/run-mike.py {posargs}

[testenv:deploy-gitlab]
passenv =
  {[testenv]passenv}
  CI_*
commands =
  mkdocs build --strict --site-dir=public

[testenv:flake8]
deps =
  flake8
commands =
  flake8

[testenv:bashate]
envdir = {toxworkdir}/bashate
deps =
  bashate
commands =
  bashate {toxinidir}/scripts/from-markdown.sh {toxinidir}/scripts/list-cherries.sh {toxinidir}/.githooks/pre-commit {toxinidir}/.githooks/post-commit {toxinidir}/.githooks/pre-push

[testenv:to-odt]
envdir = {toxworkdir}/pandoc
deps =
  jinja2-cli[yaml]
commands =
  {toxinidir}/scripts/from-markdown.sh -t odt {posargs}

[testenv:to-docx]
envdir = {toxworkdir}/pandoc
deps =
  jinja2-cli[yaml]
commands =
  {toxinidir}/scripts/from-markdown.sh -t docx {posargs}

[testenv:gitlint]
envdir = {toxworkdir}/gitlint
deps = gitlint
commands = gitlint {posargs}

[testenv:yamllint]
envdir = {toxworkdir}/yamllint
deps = yamllint
commands = yamllint {toxinidir}

[testenv:markdownlint]
envdir = {toxworkdir}/markdownlint
deps =
  pymarkdownlnt!=0.9.13
commands = pymarkdown -c .pymarkdown.json scan -r docs

[testenv:bumpversion]
envdir = {toxworkdir}/bumpversion
passenv =
  # Git can only find its global configuration if it knows where the
  # user's HOME is.
  HOME
  # If we set sign_tags in .bumpversion.cfg, we need to pass in the
  # GnuPG agent reference to avoid having to retype the passphrase for
  # an already-cached private key.
  GPG_AGENT_INFO
deps = bump2version
commands = bump2version {posargs}