-
Notifications
You must be signed in to change notification settings - Fork 25
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Force doc style check with Vale before building the doc #689
Conversation
be3c2ea
to
318d38f
Compare
Codecov Report
@@ Coverage Diff @@
## master #689 +/- ##
==========================================
+ Coverage 88.20% 88.23% +0.02%
==========================================
Files 69 69
Lines 7760 7760
==========================================
+ Hits 6845 6847 +2
+ Misses 915 913 -2 |
@PipKat @Revathyvenugopal162 I am having Vale errors I do not know how to fix:
|
@PProfizi You want to tag all file names in literal strings, like this If you'd like, I can check out your branch and resolve all of the Vale errors. |
Hi @PipKat! Thank you! I've proposed modifications to make the Vale test pass, please tell me if what I did is ok as I am not sure this is the best way to allow for what we want. |
Running the DPF Server in a Docker container | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Running the DPF Server in a Docker container | |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
Running DPF Server in a Docker container | |
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
```Based on the "Getting started with DPF Server" title earlier, it looks like DPF Server is being used like a product name. Consequently, the "the" isn't necessary. |
|
||
Running the DPF Server in a Docker container | ||
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
||
1. Along with the ansys_dpf_server_lin_v2023.2.pre0.zip archive mentioned in :ref:`Installing DPF Server <target_installing_server>`, download the Dockerfile. | ||
2. Copy both the archive and Dockerfile in a folder and navigate into that folder. | ||
1. Along with the ansys_dpf_server_lin_v2023.2.pre0.zip archive mentioned in :ref:`Installing DPF Server <target_installing_server>`, download the ``Dockerfile``. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@PProfizi Is the name of the file Dockerfile
? If so, you have written and tagged it correctly. If it is a generic reference, it should be "download the Docker file" with it being two words--a file belonging to or related to Docker.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@PipKat yes indeed the file is named Dockerfile
Your changes look good to me! I'm not sure what the :class: directive is only causing issues locally. Perhaps the links can only be built as part of the GitHub workflow? |
Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
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 sphinx
How to integrate it to PyCharm as a tool:
https://vale.sh/docs/integrations/jetbrains/