Force doc style check with Vale before building the doc #218
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
@@ Coverage Diff @@
## master #218 +/- ##
=======================================
Coverage 83.64% 83.64%
=======================================
Files 25 25
Lines 1351 1351
=======================================
Hits 1130 1130
Misses 221 221 |
PProfizi
force-pushed
the
ci/integrate_vale
branch
from
129e5d7 to
4c0f8ff
Compare
PProfizi
requested review from
PipKat,
Revathyvenugopal162,
anslpa,
cbellot000,
GuillemBarroso,
rafacanton and
JennaPaikowsky
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Vale had been integrated to the repository but only within a manually triggerable workflow.
This PR calls this workflow in the regular CI as a check step before building the documentation.
https://vale.sh/docs/vale-cli/overview/
Install Vale on Windows using choco (also explains how to install chocolatey):
https://docsy-site.netlify.app/docs/vale/install-vale/
Also install Sphinx using choco (required to treat .rst files):
choco install sphinxEdit: does not seem to work in all cases, local usage TBD
How to integrate it to PyCharm as a tool to run before commiting:
https://vale.sh/docs/integrations/jetbrains/