Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions doc/source/coding-style/formatting-tools.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://reuse.software/>`_. 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
<https://github.com/ansys/pre-commit-hooks/blob/main/src/ansys/pre_commit_hooks/assets/LICENSES/MIT.txt>`_.

For information on customizing the hook, see the `README <https://github.com/ansys/pre-commit-hooks/blob/main/README.rst>` file.


Code coverage
-------------
Code coverage indicates the percentage of the codebase tested by the test
Expand Down Expand Up @@ -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:
Expand Down
1 change: 1 addition & 0 deletions doc/styles/Vocab/ANSYS/accept.txt
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,7 @@ PEP 518
pluggable
[Pp]ostprocessing
Protobuf
proto
(?i)Pyaedt
(?i)Pyansys
Pydocstyle
Expand Down
2 changes: 1 addition & 1 deletion requirements/requirements_doc.txt
Original file line number Diff line number Diff line change
@@ -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
Expand Down