mirror of
https://github.com/adrienverge/yamllint.git
synced 2024-11-21 15:17:22 -06:00
Add rstcheck to CI to lint docs
This commit is contained in:
parent
c268a82c5a
commit
e49a101160
5
.github/workflows/ci.yaml
vendored
5
.github/workflows/ci.yaml
vendored
@ -17,10 +17,13 @@ jobs:
|
||||
uses: actions/checkout@v2
|
||||
- name: Set up Python
|
||||
uses: actions/setup-python@v2
|
||||
- run: python -m pip install flake8 flake8-import-order doc8 sphinx
|
||||
- run:
|
||||
python -m pip install flake8 flake8-import-order doc8 sphinx
|
||||
rstcheck[sphinx]
|
||||
- run: python -m pip install .
|
||||
- run: flake8 .
|
||||
- run: doc8 $(git ls-files '*.rst')
|
||||
- run: rstcheck --ignore-directives automodule $(git ls-files '*.rst')
|
||||
- run: yamllint --strict $(git ls-files '*.yaml' '*.yml')
|
||||
- run: python setup.py build_sphinx
|
||||
|
||||
|
@ -74,7 +74,7 @@ Usage
|
||||
# Output a parsable format (for syntax checking in editors like Vim, emacs...)
|
||||
yamllint -f parsable file.yaml
|
||||
|
||||
`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`_
|
||||
`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`__
|
||||
|
||||
Features
|
||||
^^^^^^^^
|
||||
@ -132,7 +132,7 @@ Specific files can be ignored (totally or for some rules only) using a
|
||||
*.ignore-trailing-spaces.yaml
|
||||
/ascii-art/*
|
||||
|
||||
`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`_
|
||||
`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`__
|
||||
|
||||
License
|
||||
-------
|
||||
|
Loading…
Reference in New Issue
Block a user