From 633cd28c55e9553c726e728b252d436c2e0dd49c Mon Sep 17 00:00:00 2001 From: klmcadams Date: Mon, 15 Apr 2024 14:03:28 -0400 Subject: [PATCH 1/7] change to private_read_pat --- doc/source/how-to/releasing.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/source/how-to/releasing.rst b/doc/source/how-to/releasing.rst index dd7eb197d..50465ff18 100644 --- a/doc/source/how-to/releasing.rst +++ b/doc/source/how-to/releasing.rst @@ -436,10 +436,10 @@ You can download artifacts from the Ansys private PyPI, public PyPI, and GitHub. .. dropdown:: Download artifacts from the Ansys private PyPI - Request the value of the ``PYANSYS_PYPI_PRIVATE_PAT`` token by sending an + Request the value of the ``PYANSYS_PYPI_PRIVATE_READ_PAT`` token by sending an email to the `pyansys.core@ansys.com `_ email. - Create an environment variable named ``PYANSYS_PYPI_PRIVATE_PAT`` in your + Create an environment variable named ``PYANSYS_PYPI_PRIVATE_READ_PAT`` in your local machine an assign it the value of the token. .. warning:: @@ -466,22 +466,22 @@ You can download artifacts from the Ansys private PyPI, public PyPI, and GitHub. .. code-block:: bat - set PYANSYS_PYPI_PRIVATE_PAT= - set INDEX_URL=https://%PYANSYS_PYPI_PRIVATE_PAT%@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/ + set PYANSYS_PYPI_PRIVATE_READ_PAT= + set INDEX_URL=https://%PYANSYS_PYPI_PRIVATE_READ_PAT%@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/ python -m pip install ansys-- --index-url %INDEX_URL% --no-dependencies .. tab-item:: PowerShell .. code-block:: powershell - $env:INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/' + $env:INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_READ_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/' python -m pip install ansys-- --index-url $env:INDEX_URL --no-dependencies .. tab-item:: macOS .. code-block:: text - export INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/' + export INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_READ_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/' python -m pip install ansys-- \ --index-url $INDEX_URL \ @@ -491,7 +491,7 @@ You can download artifacts from the Ansys private PyPI, public PyPI, and GitHub. .. code-block:: text - export INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/' + export INDEX_URL='https://$PYANSYS_PYPI_PRIVATE_READ_PAT@pkgs.dev.azure.com/pyansys/_packaging/pyansys/pypi/simple/' python -m pip install ansys-- \ --index-url $INDEX_URL \ From cb28d2955e4668792ce253a6a9a735a7f0e59c0b Mon Sep 17 00:00:00 2001 From: klmcadams Date: Mon, 15 Apr 2024 15:08:17 -0400 Subject: [PATCH 2/7] update for vale 3.1.0 --- .github/workflows/ci_cd.yml | 2 +- .pre-commit-config.yaml | 2 +- doc/styles/.gitignore | 4 ++-- doc/styles/{Vocab => vocabularies}/ANSYS/accept.txt | 0 doc/styles/{Vocab => vocabularies}/ANSYS/reject.txt | 0 5 files changed, 4 insertions(+), 4 deletions(-) rename doc/styles/{Vocab => vocabularies}/ANSYS/accept.txt (100%) rename doc/styles/{Vocab => vocabularies}/ANSYS/reject.txt (100%) diff --git a/.github/workflows/ci_cd.yml b/.github/workflows/ci_cd.yml index f864db5a9..5acc318f2 100644 --- a/.github/workflows/ci_cd.yml +++ b/.github/workflows/ci_cd.yml @@ -34,7 +34,7 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} vale-config: "doc/.vale.ini" - vale-version: "2.29.6" + vale-version: "3.1.0" doc-build: name: "Build project documentation" diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 6477ad770..4f878f531 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -35,7 +35,7 @@ repos: rev: v2.2.6 hooks: - id: codespell - args: ["--ignore-words", "doc/styles/Vocab/ANSYS/accept.txt"] + args: ["--ignore-words", "doc/styles/vocabularies/ANSYS/accept.txt"] - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.6.0 diff --git a/doc/styles/.gitignore b/doc/styles/.gitignore index 080f12aa4..f98a973cd 100644 --- a/doc/styles/.gitignore +++ b/doc/styles/.gitignore @@ -1,4 +1,4 @@ * -!Vocab -!Vocab/** +!vocabularies +!vocabularies/** !.gitignore \ No newline at end of file diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/vocabularies/ANSYS/accept.txt similarity index 100% rename from doc/styles/Vocab/ANSYS/accept.txt rename to doc/styles/vocabularies/ANSYS/accept.txt diff --git a/doc/styles/Vocab/ANSYS/reject.txt b/doc/styles/vocabularies/ANSYS/reject.txt similarity index 100% rename from doc/styles/Vocab/ANSYS/reject.txt rename to doc/styles/vocabularies/ANSYS/reject.txt From 35d8dd99b1ebfcf5a39ca045bed35293d08c4ee0 Mon Sep 17 00:00:00 2001 From: klmcadams Date: Mon, 15 Apr 2024 15:13:12 -0400 Subject: [PATCH 3/7] add config directory --- doc/styles/vocabularies/ANSYS/accept.txt | 114 ----------------------- doc/styles/vocabularies/ANSYS/reject.txt | 0 2 files changed, 114 deletions(-) delete mode 100644 doc/styles/vocabularies/ANSYS/accept.txt delete mode 100644 doc/styles/vocabularies/ANSYS/reject.txt diff --git a/doc/styles/vocabularies/ANSYS/accept.txt b/doc/styles/vocabularies/ANSYS/accept.txt deleted file mode 100644 index 11c360409..000000000 --- a/doc/styles/vocabularies/ANSYS/accept.txt +++ /dev/null @@ -1,114 +0,0 @@ -(?i)Ansys -(?i)Api -(?i)Apis -autogenerated -BCs -[Bb]lacken-[Dd]ocs -Booleans -Brinkrolf -CI/CD -CLI -CNAME -Codespell -[Cc]omponentization -[Cc]omponentizing -composability -cybersecurity -dataframes -datagrams -[Dd]ependabot -deserialize -deserializes -Deserializing -Dev -(?i)Dns -[Dd]ocformatter -[Dd]ocstring -[Dd]ocstrings -[Dd]octest -Docutils -dotfiles -dunder -[Ee]num -[Ee]nums -Fortran -(?i)Git -[Gg]itHub -GitHub Actions -[Hh]otfixes -Hpertext -(?i)Html -imag -initialisms -initializer -internetworking -[Ii]sort -linenos -matplotlib -Maxime -MeiliSearch -metapackage -Microelectromechanical -monospaced -Muela -[Nn]amespace -numpy -[Nn]umpydoc -[Pp]arametrizing -parm -PAT -PEP 8 -PEP 517 -PEP 518 -[Pp][Dd][Ff] -plaintext -pluggable -[Pp]ostprocessing -(?i)PR -Protobuf -proto -(?i)PY -(?i)Pyaedt -(?i)Pyansys -Pydocstyle -Pylance -(?i)Pymapdl -PyMeilisearch -PyPI -pytest -[Pp]ython -pythoncom -pyvista -rebasing -recurse -reusability -Rey -REST -RPC -RST -rulesets -scipy -[Ss]etuptools -[Ss]phinx -SSH -subclassing -sublist -[Ss]ubpackage -[Ss]ubpackages -substring -superset -tensorflow -TXT -turbomachinery -UDFs -uncomment -unittest -untracked -unvalidated -URIs -Vale -venv -Visual Studio Code -worktree -(?i)WSL -WSL2 diff --git a/doc/styles/vocabularies/ANSYS/reject.txt b/doc/styles/vocabularies/ANSYS/reject.txt deleted file mode 100644 index e69de29bb..000000000 From 28baec026fdc3c0f9910dab2ed0741a192f33b27 Mon Sep 17 00:00:00 2001 From: klmcadams Date: Mon, 15 Apr 2024 15:14:09 -0400 Subject: [PATCH 4/7] update pre-commit config --- .pre-commit-config.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 4f878f531..e6a344b0b 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -35,7 +35,7 @@ repos: rev: v2.2.6 hooks: - id: codespell - args: ["--ignore-words", "doc/styles/vocabularies/ANSYS/accept.txt"] + args: ["--ignore-words", "doc/styles/config/vocabularies/ANSYS/accept.txt"] - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.6.0 From 531b19dc7a8a0d563cd961c2d74ac219c0f2c4e7 Mon Sep 17 00:00:00 2001 From: klmcadams Date: Mon, 15 Apr 2024 15:19:06 -0400 Subject: [PATCH 5/7] force add files --- .../config/vocabularies/ANSYS/accept.txt | 114 ++++++++++++++++++ .../config/vocabularies/ANSYS/reject.txt | 0 2 files changed, 114 insertions(+) create mode 100644 doc/styles/config/vocabularies/ANSYS/accept.txt create mode 100644 doc/styles/config/vocabularies/ANSYS/reject.txt diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt new file mode 100644 index 000000000..11c360409 --- /dev/null +++ b/doc/styles/config/vocabularies/ANSYS/accept.txt @@ -0,0 +1,114 @@ +(?i)Ansys +(?i)Api +(?i)Apis +autogenerated +BCs +[Bb]lacken-[Dd]ocs +Booleans +Brinkrolf +CI/CD +CLI +CNAME +Codespell +[Cc]omponentization +[Cc]omponentizing +composability +cybersecurity +dataframes +datagrams +[Dd]ependabot +deserialize +deserializes +Deserializing +Dev +(?i)Dns +[Dd]ocformatter +[Dd]ocstring +[Dd]ocstrings +[Dd]octest +Docutils +dotfiles +dunder +[Ee]num +[Ee]nums +Fortran +(?i)Git +[Gg]itHub +GitHub Actions +[Hh]otfixes +Hpertext +(?i)Html +imag +initialisms +initializer +internetworking +[Ii]sort +linenos +matplotlib +Maxime +MeiliSearch +metapackage +Microelectromechanical +monospaced +Muela +[Nn]amespace +numpy +[Nn]umpydoc +[Pp]arametrizing +parm +PAT +PEP 8 +PEP 517 +PEP 518 +[Pp][Dd][Ff] +plaintext +pluggable +[Pp]ostprocessing +(?i)PR +Protobuf +proto +(?i)PY +(?i)Pyaedt +(?i)Pyansys +Pydocstyle +Pylance +(?i)Pymapdl +PyMeilisearch +PyPI +pytest +[Pp]ython +pythoncom +pyvista +rebasing +recurse +reusability +Rey +REST +RPC +RST +rulesets +scipy +[Ss]etuptools +[Ss]phinx +SSH +subclassing +sublist +[Ss]ubpackage +[Ss]ubpackages +substring +superset +tensorflow +TXT +turbomachinery +UDFs +uncomment +unittest +untracked +unvalidated +URIs +Vale +venv +Visual Studio Code +worktree +(?i)WSL +WSL2 diff --git a/doc/styles/config/vocabularies/ANSYS/reject.txt b/doc/styles/config/vocabularies/ANSYS/reject.txt new file mode 100644 index 000000000..e69de29bb From b58c0708a40dd23950237f20f84b347ecfba76ca Mon Sep 17 00:00:00 2001 From: klmcadams Date: Mon, 15 Apr 2024 15:48:19 -0400 Subject: [PATCH 6/7] comment out tokenignores --- doc/.vale.ini | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/doc/.vale.ini b/doc/.vale.ini index 930dd2dde..bb0701c5d 100644 --- a/doc/.vale.ini +++ b/doc/.vale.ini @@ -29,7 +29,7 @@ BasedOnStyles = Vale, Google Vale.Terms = NO # Inline roles are ignored -TokenIgnores = (:.*:`.*`) +# TokenIgnores = (:.*:`.*`) # Removing Google-specific rule - Not applicable under some circumstances Google.WordList = NO From 1995062390175919aca7d20f629e7eb6f18e7252 Mon Sep 17 00:00:00 2001 From: klmcadams Date: Mon, 15 Apr 2024 17:07:59 -0400 Subject: [PATCH 7/7] vale warnings? --- doc/.vale.ini | 5 ++--- doc/source/coding-style/required-standard.rst | 2 +- .../content-writing/examples-writers/sphinx-gallery.rst | 2 +- doc/source/content-writing/rst-files-writers/index.rst | 4 ++-- doc/source/packaging/build-systems.rst | 2 +- doc/styles/config/vocabularies/ANSYS/accept.txt | 1 + 6 files changed, 8 insertions(+), 8 deletions(-) diff --git a/doc/.vale.ini b/doc/.vale.ini index bb0701c5d..19bb6f179 100644 --- a/doc/.vale.ini +++ b/doc/.vale.ini @@ -2,7 +2,7 @@ # ============= # Location of our `styles` -StylesPath = "styles" +StylesPath = styles # The options are `suggestion`, `warning`, or `error` (defaults to “warning”). MinAlertLevel = warning @@ -23,13 +23,12 @@ Packages = Google Vocab = ANSYS [*.{rst}] - # Apply the following styles BasedOnStyles = Vale, Google Vale.Terms = NO # Inline roles are ignored -# TokenIgnores = (:.*:`.*`) +TokenIgnores = (:.*:`.*`) # Removing Google-specific rule - Not applicable under some circumstances Google.WordList = NO diff --git a/doc/source/coding-style/required-standard.rst b/doc/source/coding-style/required-standard.rst index f12a52c3e..711597480 100644 --- a/doc/source/coding-style/required-standard.rst +++ b/doc/source/coding-style/required-standard.rst @@ -35,7 +35,7 @@ Required ``pyproject.toml`` file configuration [tool.pydocstyle] convention = "numpy" -Required Flake8 configuration +Required flake8 configuration ----------------------------- The following ``.flake8`` file is also required: diff --git a/doc/source/content-writing/examples-writers/sphinx-gallery.rst b/doc/source/content-writing/examples-writers/sphinx-gallery.rst index 8a86beaaf..daf20a3b5 100644 --- a/doc/source/content-writing/examples-writers/sphinx-gallery.rst +++ b/doc/source/content-writing/examples-writers/sphinx-gallery.rst @@ -1,6 +1,6 @@ .. _sphinx-gallery: -Use Sphinx-Gallery +Use sphinx-gallery ================== The `sphinx_gallery `_ extension (Sphinx-Gallery) is diff --git a/doc/source/content-writing/rst-files-writers/index.rst b/doc/source/content-writing/rst-files-writers/index.rst index 5ea20bc34..2a59bc8a6 100644 --- a/doc/source/content-writing/rst-files-writers/index.rst +++ b/doc/source/content-writing/rst-files-writers/index.rst @@ -77,8 +77,8 @@ For more information on RST file setup, see :ref:`rst_files_developers` and .. _readme_files: -README files ------------- +``README.rst`` files +-------------------- Each PyAnsys repository has a README file in its root directory that explains the project and points readers to the documentation. The README file can be an RST file diff --git a/doc/source/packaging/build-systems.rst b/doc/source/packaging/build-systems.rst index cca6281f4..4bddeac10 100644 --- a/doc/source/packaging/build-systems.rst +++ b/doc/source/packaging/build-systems.rst @@ -86,7 +86,7 @@ The combination of PEP 517 and PEP 518 leads to the following syntax in a requires = ["flit"] # Defined by PEP 518 build-backend = "flit_core.api" # Defined by PEP 517 -build-backend tools +Build-backend tools =================== This section lists some of the most popular build systems in the diff --git a/doc/styles/config/vocabularies/ANSYS/accept.txt b/doc/styles/config/vocabularies/ANSYS/accept.txt index 11c360409..0259b88b5 100644 --- a/doc/styles/config/vocabularies/ANSYS/accept.txt +++ b/doc/styles/config/vocabularies/ANSYS/accept.txt @@ -9,6 +9,7 @@ Brinkrolf CI/CD CLI CNAME +CSV Codespell [Cc]omponentization [Cc]omponentizing