Skip to content

Commit

Permalink
Fix markdownlint test (#2095)
Browse files Browse the repository at this point in the history
Travis only gives us Node.js version 8 so we must use an older
version of markdownlint. To declare a newer node.js version we
lose the ability to have Python as the lang and install tox.
If/when the default node version gets updated, remove the
version restriction on markdownlint.
  • Loading branch information
waylan committed May 7, 2020
1 parent 1ad6a91 commit a4eb4eb
Show file tree
Hide file tree
Showing 3 changed files with 14 additions and 4 deletions.
7 changes: 6 additions & 1 deletion .travis.yml
Expand Up @@ -7,7 +7,12 @@ matrix:
# Default Python
- env: TOXENV=flake8
- env: TOXENV=markdown-lint
before_install: npm install -g markdownlint-cli
# Travis only gives us Node.js version 8 so we must use an older
# version of markdownlint. To declare a newer node.js version we
# lose the ability to have Python as the lang and install tox.
# If/when the default node version gets updated, remove the
# version restriction on markdownlint.
before_install: npm install -g markdownlint-cli@0.21.0
# Until Linkchecker is updated to Python 3, we will have skip this test.
# Watch https://github.com/linkchecker/linkchecker for updates.
# - env: TOXENV=linkchecker
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guide/custom-themes.md
Expand Up @@ -60,7 +60,7 @@ theme:

!!! Warning

A theme's [configuration] defined in a `mkdocs_theme.yml` file is not loaded
A theme's [configuration] defined in a `mkdocs_theme.yml` file is not loaded
from `theme.custom_dir`. When an entire theme exists in `theme.custom_dir`
and `theme.name` is set to `null`, then the entire theme configuration must
be defined in the [theme] configuration option in the `mkdocs.yml` file.
Expand Down
9 changes: 7 additions & 2 deletions tox.ini
Expand Up @@ -20,9 +20,14 @@ deps=-rrequirements/test.txt
commands={envbindir}/flake8 mkdocs --max-line-length=119

[testenv:markdown-lint]
whitelist_externals = markdownlint
whitelist_externals=
node
markdownlint
passenv = *
commands=markdownlint README.md CONTRIBUTING.md docs/
commands=
node --version
markdownlint --version
markdownlint README.md CONTRIBUTING.md docs/ --ignore docs/CNAME

[testenv:linkchecker]
basepython = python2.7
Expand Down

0 comments on commit a4eb4eb

Please sign in to comment.