-
Notifications
You must be signed in to change notification settings - Fork 135
Implementing vale #1644
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
Merged
Implementing vale #1644
Changes from 10 commits
Commits
Show all changes
20 commits
Select commit
Hold shift + click to select a range
e0d88b4
Implementing vale
RobPasMue 3adb4f1
First commit for fixing Vale issues. More to come.....
PipKat afd2d81
Commit morning edits
PipKat 10fc3ff
Third commit for fixing Vale issues
PipKat e41a626
Final commit before US Thanksgiving break
PipKat 6cb5a61
Merge branch 'main' into feat/vale
RobPasMue 88fbeb7
Solving remaining vale errors and warnings
RobPasMue 5bf6370
Codestyle errors
RobPasMue e153b13
Solving warnings in MAPDL docs build
RobPasMue 79848e4
Editing links.rst SciPy ref
RobPasMue 659b425
Adding links and modfied section about VPN.
germa89 7a312aa
Apply suggestions from code review
RobPasMue d69f140
Update doc/source/troubleshoot/troubleshoot.rst
RobPasMue 4d96711
Update doc/source/troubleshoot/troubleshoot.rst
RobPasMue 458ddd9
Update doc/source/user_guide/upf.rst
RobPasMue 0819141
Update doc/source/troubleshoot/troubleshoot.rst
RobPasMue f88528a
Update doc/source/examples/technology_showcase_examples/techdemo-28/e…
RobPasMue a2139d2
Merge branch 'main' into feat/vale
RobPasMue 7a559b8
Updating techdemos links
RobPasMue 77bd44e
Solving warnings
RobPasMue File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,23 +36,28 @@ permissions: | |
|
||
jobs: | ||
|
||
stylecheck: | ||
name: Style Check | ||
style: | ||
name: Code style | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v3 | ||
- name: Setup Python | ||
uses: actions/[email protected] | ||
- name: PyAnsys code style checks | ||
uses: pyansys/actions/code-style@v1 | ||
with: | ||
python-version: 3.9 | ||
- name: Install pre-commit | ||
run: pip install pre-commit | ||
- name: Run pre-commit | ||
run: pre-commit run --all-files || ( git status --short ; git diff ; exit 1 ) | ||
|
||
doc-style: | ||
name: Documentation style check | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: PyAnsys documentation style checks | ||
uses: pyansys/actions/doc-style@v1 | ||
with: | ||
token: ${{ secrets.GITHUB_TOKEN }} | ||
|
||
testimport: | ||
name: Smoke Tests | ||
runs-on: ${{ matrix.os }} | ||
needs: [style] | ||
strategy: | ||
matrix: | ||
os: [windows-latest, ubuntu-latest] | ||
|
@@ -116,11 +121,11 @@ jobs: | |
docs_build: | ||
name: Build Documentation | ||
runs-on: ubuntu-latest | ||
needs: [doc-style] | ||
env: | ||
PYMAPDL_PORT: 21000 # default won't work on GitHub runners | ||
PYMAPDL_DB_PORT: 21001 # default won't work on GitHub runners | ||
PYMAPDL_START_INSTANCE: FALSE | ||
|
||
steps: | ||
- uses: actions/checkout@v3 | ||
|
||
|
@@ -304,6 +309,7 @@ jobs: | |
build_test: | ||
name: Build and Unit Testing | ||
runs-on: ubuntu-latest | ||
needs: [style] | ||
strategy: | ||
matrix: | ||
mapdl-version: ['v21.1.1', 'v21.2.1', 'v22.1.0', 'v22.2.0', 'v22.2-ubuntu'] | ||
|
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
# Core settings | ||
# ============= | ||
|
||
# Location of our `styles` | ||
StylesPath = "styles" | ||
|
||
# The options are `suggestion`, `warning`, or `error` (defaults to “warning”). | ||
MinAlertLevel = warning | ||
|
||
# By default, `code` and `tt` are ignored. | ||
IgnoredScopes = code, tt | ||
|
||
# By default, `script`, `style`, `pre`, and `figure` are ignored. | ||
SkippedScopes = script, style, pre, figure | ||
|
||
# WordTemplate specifies what Vale will consider to be an individual word. | ||
WordTemplate = \b(?:%s)\b | ||
|
||
# List of Packages to be used for our guidelines | ||
Packages = Google | ||
|
||
# Define the Ansys vocabulary | ||
Vocab = ANSYS | ||
|
||
[*.{md,rst}] | ||
|
||
# Apply the following styles | ||
BasedOnStyles = Vale, Google | ||
|
||
# Removing Google-specific rule - Not applicable under some circumstances | ||
Google.Colons = NO |
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,8 +1,10 @@ | ||
:orphan: | ||
|
||
.. vale off | ||
|
||
Oops! | ||
===== | ||
|
||
.. vale on | ||
|
||
This is unexpected. | ||
|
||
|
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,7 +13,7 @@ contribute to PyMAPDL. | |
The following contribution information is specific to PyMAPDL. | ||
|
||
|
||
Cloning the PyMAPDL Repository | ||
Cloning the PyMAPDL repository | ||
============================== | ||
|
||
Run this code to clone and install the latest version of PyMAPDL in development mode: | ||
|
@@ -26,12 +26,12 @@ Run this code to clone and install the latest version of PyMAPDL in development | |
pip install -e . | ||
|
||
|
||
Posting Issues | ||
Posting issues | ||
============== | ||
|
||
Use the `PyMAPDL Issues <pymapdl_issues_>`_ | ||
page to submit questions, report bugs, and request new features. When possible, we | ||
recommend that you use these issue templates: | ||
page to submit questions, report bugs, and request new features. When possible, | ||
use these issue templates: | ||
|
||
* Bug report template | ||
* Feature request template | ||
|
@@ -40,7 +40,7 @@ If your issue does not fit into one of these categories, create your own issue. | |
|
||
To reach the project support team, email `[email protected] <pyansys_support_>`_. | ||
|
||
Viewing PyMAPDL Documentation | ||
Viewing PyMAPDL documentation | ||
============================= | ||
|
||
Documentation for the latest stable release of PyMAPDL is hosted at | ||
|
@@ -77,7 +77,7 @@ This tells ``ansys.mapdl.core`` to attempt to connect to the existing | |
MAPDL service by default when the ``launch_mapdl`` function is used. | ||
|
||
|
||
Code Style | ||
Code style | ||
========== | ||
|
||
PyMAPDL follows PEP8 standard as outlined in the `PyAnsys Development Guide | ||
|
@@ -105,16 +105,16 @@ This way, it's not possible for you to push code that fails the style checks. Fo | |
|
||
.. _ref_index_api: | ||
|
||
API Reference | ||
API reference | ||
============= | ||
This page gives an overview of the API of several public PyMAPDL | ||
classes, functions, and attributes. You can find them | ||
on the left sidebar. | ||
|
||
These methods may include some MAPDL commands but are generally | ||
specific to pymapdl specific methods and classes (i.e. methods that | ||
extend existing MAPDL methods in a pythonic manner). For classic | ||
MAPDL commands mapped to PyMAPDL, see :ref:`ref_mapdl_commands`. | ||
While these methods might include some MAPDL commands, they are generally | ||
specific to PyMAPDL methods and classes. PyMAPDL methods extend existing | ||
MAPDL methods in a Pythonic manner. For a mapping of MAPDL commands to | ||
PyMAPDL, see :ref:`ref_mapdl_commands`. | ||
|
||
|
||
.. toctree:: | ||
|
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
.. _ref_pool_api: | ||
|
||
Local MAPDL Pool | ||
Local MAPDL pool | ||
================ | ||
|
||
.. currentmodule:: ansys.mapdl.core | ||
|
This file contains hidden or 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
This file contains hidden or 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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,6 @@ | ||
.. _ref_xpl_api: | ||
|
||
Database Explorer | ||
Database explorer | ||
================= | ||
.. currentmodule:: ansys.mapdl.core | ||
|
||
|
This file contains hidden or 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
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.