From e49a1011600d8e9831f205e659c389490c2cf7f5 Mon Sep 17 00:00:00 2001 From: Andrew Imeson Date: Mon, 6 Jun 2022 14:48:10 -0400 Subject: [PATCH] Add rstcheck to CI to lint docs --- .github/workflows/ci.yaml | 5 ++++- README.rst | 4 ++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yaml b/.github/workflows/ci.yaml index 26cea6c..c56fa17 100644 --- a/.github/workflows/ci.yaml +++ b/.github/workflows/ci.yaml @@ -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 diff --git a/README.rst b/README.rst index 3383ec4..fe78142 100644 --- a/README.rst +++ b/README.rst @@ -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! `_ +`Read more in the complete documentation! `__ 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! `_ +`Read more in the complete documentation! `__ License -------