NuKVM/yamllint
3
0
Fork 0
mirror of https://github.com/adrienverge/yamllint.git synced 2024-11-25 00:50:16 -06:00
Code Issues Packages Projects Releases Wiki Activity

Add rstcheck to CI to lint docs

Browse Source
This commit is contained in:
Andrew Imeson 2022-06-06 14:48:10 -04:00 committed by Adrien Vergé
parent c268a82c5a
commit e49a101160
2 changed files with 6 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.github/workflows/ci.yaml vendored
View File

@ -17,10 +17,13 @@ jobs:
uses: actions/checkout@v2 uses: actions/checkout@v2
- name: Set up Python - name: Set up Python
uses: actions/setup-python@v2 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: python -m pip install .
- run: flake8 . - run: flake8 .
- run: doc8 $(git ls-files '*.rst') - run: doc8 $(git ls-files '*.rst')
- run: rstcheck --ignore-directives automodule $(git ls-files '*.rst')
- run: yamllint --strict $(git ls-files '*.yaml' '*.yml') - run: yamllint --strict $(git ls-files '*.yaml' '*.yml')
- run: python setup.py build_sphinx - run: python setup.py build_sphinx

4
README.rst
View File

@ -74,7 +74,7 @@ Usage
# Output a parsable format (for syntax checking in editors like Vim, emacs...) # Output a parsable format (for syntax checking in editors like Vim, emacs...)
yamllint -f parsable file.yaml 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 Features
^^^^^^^^ ^^^^^^^^
@ -132,7 +132,7 @@ Specific files can be ignored (totally or for some rules only) using a
*.ignore-trailing-spaces.yaml *.ignore-trailing-spaces.yaml
/ascii-art/* /ascii-art/*
`Read more in the complete documentation! <https://yamllint.readthedocs.io/>`_ `Read more in the complete documentation! <https://yamllint.readthedocs.io/>`__
License License
------- -------