diff options
Diffstat (limited to 'doc/tools/make_rst.py')
| -rwxr-xr-x | doc/tools/make_rst.py | 52 |
1 files changed, 48 insertions, 4 deletions
diff --git a/doc/tools/make_rst.py b/doc/tools/make_rst.py index 0649a0bb62..54bad7cf05 100755 --- a/doc/tools/make_rst.py +++ b/doc/tools/make_rst.py @@ -66,6 +66,15 @@ BASE_STRINGS = [ "This method doesn't need an instance to be called, so it can be called directly using the class name.", "This method describes a valid operator to use with this type as left-hand operand.", "This value is an integer composed as a bitmask of the following flags.", + "There is currently no description for this class. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!", + "There is currently no description for this signal. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!", + "There is currently no description for this annotation. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!", + "There is currently no description for this property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!", + "There is currently no description for this constructor. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!", + "There is currently no description for this method. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!", + "There is currently no description for this operator. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!", + "There is currently no description for this theme property. Please help us by :ref:`contributing one <doc_updating_the_class_reference>`!", + "There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information.", ] strings_l10n: Dict[str, str] = {} @@ -92,6 +101,36 @@ EDITOR_CLASSES: List[str] = [ "ScriptEditor", "ScriptEditorBase", ] +# Sync with the types mentioned in https://docs.godotengine.org/en/stable/tutorials/scripting/c_sharp/c_sharp_differences.html +CLASSES_WITH_CSHARP_DIFFERENCES: List[str] = [ + "@GlobalScope", + "String", + "NodePath", + "Signal", + "Callable", + "RID", + "Basis", + "Transform2D", + "Transform3D", + "Rect2", + "Rect2i", + "AABB", + "Quaternion", + "Projection", + "Color", + "Array", + "Dictionary", + "PackedByteArray", + "PackedColorArray", + "PackedFloat32Array", + "PackedFloat64Array", + "PackedInt32Array", + "PackedInt64Array", + "PackedStringArray", + "PackedVector2Array", + "PackedVector3Array", + "Variant", +] class State: @@ -607,10 +646,6 @@ def main() -> None: continue doc = tree.getroot() - if "version" not in doc.attrib: - print_error(f'{cur_file}: "version" attribute missing from "doc".', state) - continue - name = doc.attrib["name"] if name in classes: print_error(f'{cur_file}: Duplicate class "{name}".', state) @@ -846,6 +881,15 @@ def make_rst_class(class_def: ClassDef, state: State, dry_run: bool, output_dir: + "\n\n" ) + if class_def.name in CLASSES_WITH_CSHARP_DIFFERENCES: + f.write(".. note::\n\n\t") + f.write( + translate( + "There are notable differences when using this API with C#. See :ref:`doc_c_sharp_differences` for more information." + ) + + "\n\n" + ) + # Online tutorials if len(class_def.tutorials) > 0: f.write(".. rst-class:: classref-introduction-group\n\n") |