Update: Skip processing substitution_definition nodes

.gitattributes

@@ -1 +1,2 @@
-* text eol=lf
+* text=auto
+*.sh text eol=lf

src/fake_bpy_module/generator/translator.py

@@ -57,6 +57,23 @@ def depart_section(self, _: nodes.section) -> None:
         self.doc_writer.addln("--------------------")
         self.doc_writer.new_line()
 
+    def visit_substitution_definition(
+        self, node: nodes.substitution_definition
+    ) -> None:
+        name = node.attributes["names"][0]
+        self.doc_writer.add(f"SUBSTITUTION REPLACEMENT '{name}':")
+        self.doc_writer.new_line()
+        print(
+            f"WARNING. Found substitution definition by name '{name}'. "
+            "It's not fully supported and may be not handled properly."
+        )
+
+    def depart_substitution_definition(
+        self, _: nodes.substitution_definition
+    ) -> None:
+        self.doc_writer.new_line()
+        self.doc_writer.new_line()
+
     def visit_emphasis(self, _: nodes.emphasis) -> None:
         self.doc_writer.add("*")
 

src/fake_bpy_module/transformer/rst_specific_node_cleaner.py

@@ -30,7 +30,8 @@ def _apply(self, document: nodes.document) -> None:
                     nodes.enumerated_list | nodes.definition_list |
                     nodes.block_quote | nodes.line_block | nodes.literal_block |
                     nodes.section | nodes.field_list | nodes.note |
-                    nodes.warning | nodes.target | CodeNode):
+                    nodes.warning | nodes.target |
+                    nodes.substitution_definition | CodeNode):
                 code_doc_node = CodeDocumentNode()
                 self._replace(node, code_doc_node)
                 append_child(code_doc_node, node)

tests/python/fake_bpy_module_test/fake_bpy_module_test/analyzer_test_data/base_analyzer_test/input/only_module_class.rst

@@ -1 +1 @@
-.. module:: module_1
+.. module:: module_1

tests/python/fake_bpy_module_test/fake_bpy_module_test/generator_test_data/code_document_node_translator_test/expect/basic/basic.py

@@ -1,60 +1,63 @@
-"""
-Paragraph: *Emphasis*
-
-* Bullet List Item 1
-    * Bullet List Item 1-1
-    * Bullet List Item 1-2
-* Bullet List Item 2
-    * Bullet List Item 2-1
-    * Bullet List Item 2-2
-    * Bullet List Item 2-3
-* Bullet List Item 3
-    * Bullet List Item 3-1
-
-1. Enumerated List Item 1
-    1. Enumerated List Item 1-1
-    2. Enumerated List Item 1-2
-2. Enumerated List Item 2
-    1. Enumerated List Item 2-1
-    2. Enumerated List Item 2-2
-    3. Enumerated List Item 2-3
-3. Enumerated List Item 3
-    1. Enumerated List Item 3-1
-
-field-list-item-1: Field List Item 1 Contents
-field-list-item-2: Field List Item 2 Contents
-
-Definition List Item 1
-    Definition List Item 1 Contents
-
-Definition List Item 2
-    Definition List Item 2 Contents
-
-```
-Literal Block Contents
-```
-
-Module: module_ref, Ref: ref_ref, Class: class_ref
-Function: function_ref, Data: data_ref, Const: const_ref
-
-[NOTE]
-Note Contents
-
-[WARNING]
-Warning Contents
-
-Line Block Contents 1
-Line Block Contents 2
-
-[QUOTE]
-Quote Block Contents 1
-Quote Block Contents 2
-
-Target
-
-"""
-
-import typing
-import collections.abc
-import typing_extensions
-import numpy.typing as npt
+"""
+SUBSTITUTION REPLACEMENT 'TEST_REPLACEMENT':
+Test replacement text.
+
+Paragraph: *Emphasis*
+
+* Bullet List Item 1
+    * Bullet List Item 1-1
+    * Bullet List Item 1-2
+* Bullet List Item 2
+    * Bullet List Item 2-1
+    * Bullet List Item 2-2
+    * Bullet List Item 2-3
+* Bullet List Item 3
+    * Bullet List Item 3-1
+
+1. Enumerated List Item 1
+    1. Enumerated List Item 1-1
+    2. Enumerated List Item 1-2
+2. Enumerated List Item 2
+    1. Enumerated List Item 2-1
+    2. Enumerated List Item 2-2
+    3. Enumerated List Item 2-3
+3. Enumerated List Item 3
+    1. Enumerated List Item 3-1
+
+field-list-item-1: Field List Item 1 Contents
+field-list-item-2: Field List Item 2 Contents
+
+Definition List Item 1
+    Definition List Item 1 Contents
+
+Definition List Item 2
+    Definition List Item 2 Contents
+
+```
+Literal Block Contents
+```
+
+Module: module_ref, Ref: ref_ref, Class: class_ref
+Function: function_ref, Data: data_ref, Const: const_ref
+
+[NOTE]
+Note Contents
+
+[WARNING]
+Warning Contents
+
+Line Block Contents 1
+Line Block Contents 2
+
+[QUOTE]
+Quote Block Contents 1
+Quote Block Contents 2
+
+Target
+
+"""
+
+import typing
+import collections.abc
+import typing_extensions
+import numpy.typing as npt

tests/python/fake_bpy_module_test/fake_bpy_module_test/generator_test_data/code_document_node_translator_test/expect/basic/basic.xml

@@ -3,6 +3,8 @@
         basic.rst
     <title>
         Title
+    <substitution_definition names="TEST_REPLACEMENT">
+        Test replacement text.
     <paragraph>
         Paragraph: 
         <emphasis>

tests/python/fake_bpy_module_test/fake_bpy_module_test/generator_test_data/code_document_node_translator_test/expect/basic/basic_transformed.xml

@@ -4,6 +4,8 @@
     <code-document>
         <title>
             Title
+        <substitution_definition names="TEST_REPLACEMENT">
+            Test replacement text.
         <paragraph>
             Paragraph: 
             <emphasis>

tests/python/fake_bpy_module_test/fake_bpy_module_test/generator_test_data/code_document_node_translator_test/input/basic/basic.rst

@@ -1,6 +1,8 @@
 Title
 =====
 
+.. |TEST_REPLACEMENT| replace:: Test replacement text.
+
 Paragraph: *Emphasis*
 
 * Bullet List Item 1

tests/python/fake_bpy_module_test/fake_bpy_module_test/transformer_test_data/bpy_module_tweaker/expect/add_bpy_ops_override_parameters.xml

@@ -1,34 +1,34 @@
-<document source="<string>">
-    <source-filename>
-        add_bpy_ops_override_parameters.rst
-    <module>
-        <name>
-            bpy.ops.pose
-        <description>
-    <function function_type="function">
-        <name>
-            function_1
-        <description>
-            function_1 description
-        <argument-list>
-            <argument argument_type="arg">
-                <name>
-                    arg_1
-                <description>
-                    function_1 arg_1 description
-                <default-value>
-                <data-type-list>
-                    <data-type>
-                        function_1 arg_1 type
-        <return>
-            <description>
-            <data-type-list>
-    <function function_type="function">
-        <name>
-            function_2
-        <description>
-            function_2 description
-        <argument-list>
-        <return>
-            <description>
-            <data-type-list>
+<document source="<string>">
+    <source-filename>
+        add_bpy_ops_override_parameters.rst
+    <module>
+        <name>
+            bpy.ops.pose
+        <description>
+    <function function_type="function">
+        <name>
+            function_1
+        <description>
+            function_1 description
+        <argument-list>
+            <argument argument_type="arg">
+                <name>
+                    arg_1
+                <description>
+                    function_1 arg_1 description
+                <default-value>
+                <data-type-list>
+                    <data-type>
+                        function_1 arg_1 type
+        <return>
+            <description>
+            <data-type-list>
+    <function function_type="function">
+        <name>
+            function_2
+        <description>
+            function_2 description
+        <argument-list>
+        <return>
+            <description>
+            <data-type-list>