Exclude generated docs from pre-commit hooks

2025-08-04 11:36:52 +08:00 · 2025-06-30 17:01:49 +01:00
--- a/.pre-commit-config.yaml
+++ b/.pre-commit-config.yaml
@@ -5,7 +5,9 @@ repos:
    rev: v4.5.0
    hooks:
    -   id: trailing-whitespace
+        exclude: docs/source/developer_reference/
    -   id: end-of-file-fixer
+        exclude: docs/source/developer_reference/
    -   id: check-yaml
    -   id: check-added-large-files
        args: ['--maxkb=1000']
--- a/docs/source/developer_reference/reframe_tests.tests.base_tests.CreatePyenvTest.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.base_tests.CreatePyenvTest.rst
@@ -7,14 +7,14 @@ CreatePyenvTest

 .. autoclass:: CreatePyenvTest

-
+   
   .. automethod:: __init__

-
+   
   .. rubric:: Methods

   .. autosummary::
-
+   
      ~CreatePyenvTest.__init__
      ~CreatePyenvTest.check_performance
      ~CreatePyenvTest.check_requirements_installed
@@ -44,15 +44,15 @@ CreatePyenvTest
      ~CreatePyenvTest.skip_if
      ~CreatePyenvTest.skip_if_no_procinfo
      ~CreatePyenvTest.user_deps
+   
+   

-
-
-
-
+   
+   
   .. rubric:: Attributes

   .. autosummary::
-
+   
      ~CreatePyenvTest.build_job
      ~CreatePyenvTest.build_stderr
      ~CreatePyenvTest.build_stdout
@@ -117,3 +117,5 @@ CreatePyenvTest
      ~CreatePyenvTest.extra_resources
      ~CreatePyenvTest.build_locally
      ~CreatePyenvTest.ci_extras
+   
+   
--- a/docs/source/developer_reference/reframe_tests.tests.base_tests.GprMaxBaseTest.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.base_tests.GprMaxBaseTest.rst
@@ -7,14 +7,14 @@ GprMaxBaseTest

 .. autoclass:: GprMaxBaseTest

-
+   
   .. automethod:: __init__

-
+   
   .. rubric:: Methods

   .. autosummary::
-
+   
      ~GprMaxBaseTest.__init__
      ~GprMaxBaseTest.build_output_file_path
      ~GprMaxBaseTest.build_reference_filepath
@@ -61,15 +61,15 @@ GprMaxBaseTest
      ~GprMaxBaseTest.test_reference_files_exist
      ~GprMaxBaseTest.test_simulation_complete
      ~GprMaxBaseTest.user_deps
+   
+   

-
-
-
-
+   
+   
   .. rubric:: Attributes

   .. autosummary::
-
+   
      ~GprMaxBaseTest.build_job
      ~GprMaxBaseTest.build_stderr
      ~GprMaxBaseTest.build_stdout
@@ -135,3 +135,5 @@ GprMaxBaseTest
      ~GprMaxBaseTest.extra_resources
      ~GprMaxBaseTest.build_locally
      ~GprMaxBaseTest.ci_extras
+   
+   
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.BScanMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.BScanMixin.rst
@@ -5,4 +5,4 @@ BScanMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: BScanMixin
+.. autoclass:: BScanMixin
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.GeometryObjectsReadMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.GeometryObjectsReadMixin.rst
@@ -5,4 +5,4 @@ GeometryObjectsReadMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: GeometryObjectsReadMixin
+.. autoclass:: GeometryObjectsReadMixin
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.GeometryObjectsWriteMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.GeometryObjectsWriteMixin.rst
@@ -5,4 +5,4 @@ GeometryObjectsWriteMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: GeometryObjectsWriteMixin
+.. autoclass:: GeometryObjectsWriteMixin
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.GeometryOnlyMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.GeometryOnlyMixin.rst
@@ -5,4 +5,4 @@ GeometryOnlyMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: GeometryOnlyMixin
+.. autoclass:: GeometryOnlyMixin
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.GeometryViewMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.GeometryViewMixin.rst
@@ -5,4 +5,4 @@ GeometryViewMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: GeometryViewMixin
+.. autoclass:: GeometryViewMixin
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.MpiMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.MpiMixin.rst
@@ -5,4 +5,4 @@ MpiMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: MpiMixin
+.. autoclass:: MpiMixin
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.PythonApiMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.PythonApiMixin.rst
@@ -5,4 +5,4 @@ PythonApiMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: PythonApiMixin
+.. autoclass:: PythonApiMixin
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.ReceiverMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.ReceiverMixin.rst
@@ -5,4 +5,4 @@ ReceiverMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: ReceiverMixin
+.. autoclass:: ReceiverMixin
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.SnapshotMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.SnapshotMixin.rst
@@ -5,4 +5,4 @@ SnapshotMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: SnapshotMixin
+.. autoclass:: SnapshotMixin
--- a/docs/source/developer_reference/reframe_tests.tests.mixins.TaskfarmMixin.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.mixins.TaskfarmMixin.rst
@@ -5,4 +5,4 @@ TaskfarmMixin

 .. currentmodule:: reframe_tests.tests.mixins

-.. autoclass:: TaskfarmMixin
+.. autoclass:: TaskfarmMixin
--- a/docs/source/developer_reference/reframe_tests.tests.regression_checks.GeometryObjectMaterialsRegressionCheck.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.regression_checks.GeometryObjectMaterialsRegressionCheck.rst
@@ -7,25 +7,27 @@ GeometryObjectMaterialsRegressionCheck

 .. autoclass:: GeometryObjectMaterialsRegressionCheck

-
+   
   .. automethod:: __init__

-
+   
   .. rubric:: Methods

   .. autosummary::
-
+   
      ~GeometryObjectMaterialsRegressionCheck.__init__
      ~GeometryObjectMaterialsRegressionCheck.create_reference_file
      ~GeometryObjectMaterialsRegressionCheck.reference_file_exists
      ~GeometryObjectMaterialsRegressionCheck.run
+   
+   

-
-
-
-
+   
+   
   .. rubric:: Attributes

   .. autosummary::
-
+   
      ~GeometryObjectMaterialsRegressionCheck.error_msg
+   
+   
--- a/docs/source/developer_reference/reframe_tests.tests.regression_checks.GeometryObjectRegressionCheck.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.regression_checks.GeometryObjectRegressionCheck.rst
@@ -7,25 +7,27 @@ GeometryObjectRegressionCheck

 .. autoclass:: GeometryObjectRegressionCheck

-
+   
   .. automethod:: __init__

-
+   
   .. rubric:: Methods

   .. autosummary::
-
+   
      ~GeometryObjectRegressionCheck.__init__
      ~GeometryObjectRegressionCheck.create_reference_file
      ~GeometryObjectRegressionCheck.reference_file_exists
      ~GeometryObjectRegressionCheck.run
+   
+   

-
-
-
-
+   
+   
   .. rubric:: Attributes

   .. autosummary::
-
+   
      ~GeometryObjectRegressionCheck.error_msg
+   
+   
--- a/docs/source/developer_reference/reframe_tests.tests.regression_checks.GeometryViewRegressionCheck.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.regression_checks.GeometryViewRegressionCheck.rst
@@ -7,25 +7,27 @@ GeometryViewRegressionCheck

 .. autoclass:: GeometryViewRegressionCheck

-
+   
   .. automethod:: __init__

-
+   
   .. rubric:: Methods

   .. autosummary::
-
+   
      ~GeometryViewRegressionCheck.__init__
      ~GeometryViewRegressionCheck.create_reference_file
      ~GeometryViewRegressionCheck.reference_file_exists
      ~GeometryViewRegressionCheck.run
+   
+   

-
-
-
-
+   
+   
   .. rubric:: Attributes

   .. autosummary::
-
+   
      ~GeometryViewRegressionCheck.error_msg
+   
+   
--- a/docs/source/developer_reference/reframe_tests.tests.regression_checks.H5RegressionCheck.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.regression_checks.H5RegressionCheck.rst
@@ -7,25 +7,27 @@ H5RegressionCheck

 .. autoclass:: H5RegressionCheck

-
+   
   .. automethod:: __init__

-
+   
   .. rubric:: Methods

   .. autosummary::
-
+   
      ~H5RegressionCheck.__init__
      ~H5RegressionCheck.create_reference_file
      ~H5RegressionCheck.reference_file_exists
      ~H5RegressionCheck.run
+   
+   

-
-
-
-
+   
+   
   .. rubric:: Attributes

   .. autosummary::
-
+   
      ~H5RegressionCheck.error_msg
+   
+   
--- a/docs/source/developer_reference/reframe_tests.tests.regression_checks.ReceiverRegressionCheck.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.regression_checks.ReceiverRegressionCheck.rst
@@ -7,25 +7,27 @@ ReceiverRegressionCheck

 .. autoclass:: ReceiverRegressionCheck

-
+   
   .. automethod:: __init__

-
+   
   .. rubric:: Methods

   .. autosummary::
-
+   
      ~ReceiverRegressionCheck.__init__
      ~ReceiverRegressionCheck.create_reference_file
      ~ReceiverRegressionCheck.reference_file_exists
      ~ReceiverRegressionCheck.run
+   
+   

-
-
-
-
+   
+   
   .. rubric:: Attributes

   .. autosummary::
-
+   
      ~ReceiverRegressionCheck.error_msg
+   
+   
--- a/docs/source/developer_reference/reframe_tests.tests.regression_checks.RegressionCheck.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.regression_checks.RegressionCheck.rst
@@ -7,25 +7,27 @@ RegressionCheck

 .. autoclass:: RegressionCheck

-
+   
   .. automethod:: __init__

-
+   
   .. rubric:: Methods

   .. autosummary::
-
+   
      ~RegressionCheck.__init__
      ~RegressionCheck.create_reference_file
      ~RegressionCheck.reference_file_exists
      ~RegressionCheck.run
+   
+   

-
-
-
-
+   
+   
   .. rubric:: Attributes

   .. autosummary::
-
+   
      ~RegressionCheck.error_msg
+   
+   
--- a/docs/source/developer_reference/reframe_tests.tests.regression_checks.SnapshotRegressionCheck.rst
+++ b/docs/source/developer_reference/reframe_tests.tests.regression_checks.SnapshotRegressionCheck.rst
@@ -7,25 +7,27 @@ SnapshotRegressionCheck

 .. autoclass:: SnapshotRegressionCheck

-
+   
   .. automethod:: __init__

-
+   
   .. rubric:: Methods

   .. autosummary::
-
+   
      ~SnapshotRegressionCheck.__init__
      ~SnapshotRegressionCheck.create_reference_file
      ~SnapshotRegressionCheck.reference_file_exists
      ~SnapshotRegressionCheck.run
+   
+   

-
-
-
-
+   
+   
   .. rubric:: Attributes

   .. autosummary::
-
+   
      ~SnapshotRegressionCheck.error_msg
+   
+