Skip to content

Commit df7312f

Browse files
klmcadamsRobPasMuePipKat
authored
Add add-license-headers to docs (#392)
* add add-license-headers to docs * vale fixes * update ansys-sphinx-theme to 0.13.0 * Update doc/source/coding-style/formatting-tools.rst Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com> --------- Co-authored-by: Roberto Pastor Muela <37798125+RobPasMue@users.noreply.github.com> Co-authored-by: Kathy Pippert <84872299+PipKat@users.noreply.github.com>
1 parent 63269b2 commit df7312f

File tree

3 files changed

+20
-1
lines changed

3 files changed

+20
-1
lines changed

doc/source/coding-style/formatting-tools.rst

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -98,6 +98,19 @@ The example configuration defines these options:
9898
to print as a report when checking ends.
9999

100100

101+
Add-license-headers
102+
-------------------
103+
The goal of the ``add-license-headers`` pre-commit hook is to add and update license headers
104+
for files with `REUSE <https://reuse.software/>`_. By default, the hook runs on
105+
PROTO files in any directory and on Python files in the ``src``, ``examples``, and ``tests`` directories.
106+
107+
You can find the MIT license that is added to the files in
108+
`ansys/pre-commit-hooks repository - MIT.txt
109+
<https://github.com/ansys/pre-commit-hooks/blob/main/src/ansys/pre_commit_hooks/assets/LICENSES/MIT.txt>`_.
110+
111+
For information on customizing the hook, see the `README <https://github.com/ansys/pre-commit-hooks/blob/main/README.rst>` file.
112+
113+
101114
Code coverage
102115
-------------
103116
Code coverage indicates the percentage of the codebase tested by the test
@@ -163,6 +176,11 @@ formatting tools.
163176
additional_dependencies: [toml]
164177
exclude: "tests/"
165178
179+
- repo: https://github.com/ansys/pre-commit-hooks
180+
rev: v0.2.4
181+
hooks:
182+
- id: add-license-headers
183+
166184
Installing ``pre-commit``
167185
~~~~~~~~~~~~~~~~~~~~~~~~~
168186
You can install ``pre-commit`` by running:

doc/styles/Vocab/ANSYS/accept.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -57,6 +57,7 @@ PEP 518
5757
pluggable
5858
[Pp]ostprocessing
5959
Protobuf
60+
proto
6061
(?i)Pyaedt
6162
(?i)Pyansys
6263
Pydocstyle

requirements/requirements_doc.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
Sphinx==7.2.6
2-
ansys-sphinx-theme==0.12.5
2+
ansys-sphinx-theme==0.13.0
33
sphinx-copybutton==0.5.2
44
sphinx_toolbox==3.5.0
55
sphinx_design==0.5.0

0 commit comments

Comments
 (0)