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 def14a4f6..93b535bbb 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/config/vocabularies/ANSYS/accept.txt"] - repo: https://github.com/pre-commit/pre-commit-hooks rev: v4.6.0 diff --git a/doc/.vale.ini b/doc/.vale.ini index 930dd2dde..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,7 +23,6 @@ Packages = Google Vocab = ANSYS [*.{rst}] - # Apply the following styles BasedOnStyles = Vale, Google Vale.Terms = 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/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 \ 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/.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/config/vocabularies/ANSYS/accept.txt similarity index 99% rename from doc/styles/Vocab/ANSYS/accept.txt rename to doc/styles/config/vocabularies/ANSYS/accept.txt index 11c360409..0259b88b5 100644 --- a/doc/styles/Vocab/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 diff --git a/doc/styles/Vocab/ANSYS/reject.txt b/doc/styles/config/vocabularies/ANSYS/reject.txt similarity index 100% rename from doc/styles/Vocab/ANSYS/reject.txt rename to doc/styles/config/vocabularies/ANSYS/reject.txt