diff --git a/about/docs_changelog.rst b/about/docs_changelog.rst index ee169a098..bd28199a6 100644 --- a/about/docs_changelog.rst +++ b/about/docs_changelog.rst @@ -5,7 +5,7 @@ Documentation changelog The documentation is continually being improved. New releases include new pages, fixes and updates to existing pages, and many updates -to the :ref:`class reference `. Below is a list of new pages +to the :ref:`class reference `. Below is a list of new pages added since version 3.0. .. note:: This document only contains new pages so not all changes are reflected, diff --git a/classes/index.rst b/classes/index.rst index 185946541..fc242463c 100644 --- a/classes/index.rst +++ b/classes/index.rst @@ -1,11 +1,13 @@ :github_url: hide +.. _doc_class_reference: + Godot API ========= .. toctree:: :maxdepth: 1 - :name: toc-class-ref + :name: toc-class-ref-classes :glob: class_* diff --git a/community/contributing/contributing_to_the_documentation.rst b/community/contributing/contributing_to_the_documentation.rst index 097e2b3dd..cbae0374e 100644 --- a/community/contributing/contributing_to_the_documentation.rst +++ b/community/contributing/contributing_to_the_documentation.rst @@ -26,7 +26,7 @@ request triggers a rebuild of the online documentation upon merging. .. warning:: The class reference's source files are in the `Godot engine repository `_. We generate - the :ref:`Godot API ` section of this documentation + the :ref:`Class Reference ` section of this documentation from them. If you want to update the description of a class, its methods, or properties, read :ref:`doc_updating_the_class_reference`. diff --git a/community/contributing/updating_the_class_reference.rst b/community/contributing/updating_the_class_reference.rst index 891e1633b..cbbdf89c5 100644 --- a/community/contributing/updating_the_class_reference.rst +++ b/community/contributing/updating_the_class_reference.rst @@ -5,7 +5,7 @@ Contributing to the class reference .. highlight:: shell -The class reference is available online in the :ref:`classes ` +The class reference is available online in the :ref:`classes ` section of the documentation and in the Godot editor, from the help menu. In the class reference, some methods, variables, and signals lack descriptions. @@ -45,7 +45,7 @@ repository: `doc/classes/ .. warning:: Always edit the API reference through these source XML files. Do not edit the generated ``.rst`` files :ref:`in the online documentation - `, hosted in the `godot-docs + `, hosted in the `godot-docs `_ repository. .. warning:: diff --git a/community/contributing/ways_to_contribute.rst b/community/contributing/ways_to_contribute.rst index ea22647dc..46aff9c00 100644 --- a/community/contributing/ways_to_contribute.rst +++ b/community/contributing/ways_to_contribute.rst @@ -196,8 +196,8 @@ There are two separate resources referred to as "documentation" in Godot: - **The class reference.** This is the documentation for the complete Godot API as exposed to GDScript and the other scripting languages. It can be consulted - offline, directly in Godot's code editor, or online at :ref:`Godot API - `. To contribute to the class reference, you have to edit the + offline, directly in Godot's code editor, or online at Godot :ref:`Class Reference + `. To contribute to the class reference, you have to edit the XML file corresponding to the class and make a pull request. See :ref:`doc_updating_the_class_reference` and :ref:`doc_class_reference_writing_guidelines` for more details. diff --git a/getting_started/introduction/learning_new_features.rst b/getting_started/introduction/learning_new_features.rst index 41ab241cb..7bb569837 100644 --- a/getting_started/introduction/learning_new_features.rst +++ b/getting_started/introduction/learning_new_features.rst @@ -33,7 +33,7 @@ from within the Godot editor. To do so, go to Help -> Search or press .. image:: img/manual_class_reference_search.png -To browse it online, head to the manual's :ref:`Class Reference ` +To browse it online, head to the manual's :ref:`Class Reference ` section. A class reference's page tells you: