diff --git a/doc/source/coding-style/formatting-tools.rst b/doc/source/coding-style/formatting-tools.rst index c1a63e6d7..003b75fa3 100644 --- a/doc/source/coding-style/formatting-tools.rst +++ b/doc/source/coding-style/formatting-tools.rst @@ -98,6 +98,19 @@ The example configuration defines these options: to print as a report when checking ends. +Add-license-headers +------------------- +The goal of the ``add-license-headers`` pre-commit hook is to add and update license headers +for files with `REUSE `_. By default, the hook runs on +PROTO files in any directory and on Python files in the ``src``, ``examples``, and ``tests`` directories. + +You can find the MIT license that is added to the files in +`ansys/pre-commit-hooks repository - MIT.txt +`_. + +For information on customizing the hook, see the `README ` file. + + Code coverage ------------- Code coverage indicates the percentage of the codebase tested by the test @@ -163,6 +176,11 @@ formatting tools. additional_dependencies: [toml] exclude: "tests/" + - repo: https://github.com/ansys/pre-commit-hooks + rev: v0.2.4 + hooks: + - id: add-license-headers + Installing ``pre-commit`` ~~~~~~~~~~~~~~~~~~~~~~~~~ You can install ``pre-commit`` by running: diff --git a/doc/styles/Vocab/ANSYS/accept.txt b/doc/styles/Vocab/ANSYS/accept.txt index 7ca57f8fb..715a7ef53 100644 --- a/doc/styles/Vocab/ANSYS/accept.txt +++ b/doc/styles/Vocab/ANSYS/accept.txt @@ -57,6 +57,7 @@ PEP 518 pluggable [Pp]ostprocessing Protobuf +proto (?i)Pyaedt (?i)Pyansys Pydocstyle diff --git a/requirements/requirements_doc.txt b/requirements/requirements_doc.txt index c6507e642..19f485955 100644 --- a/requirements/requirements_doc.txt +++ b/requirements/requirements_doc.txt @@ -1,5 +1,5 @@ Sphinx==7.2.6 -ansys-sphinx-theme==0.12.5 +ansys-sphinx-theme==0.13.0 sphinx-copybutton==0.5.2 sphinx_toolbox==3.5.0 sphinx_design==0.5.0