浏览代码

Add support for split class reference

Yuri Sizov 3 年之前
父节点
当前提交
a5bf20bb6d

+ 1 - 1
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 <toc-class-ref>`. Below is a list of new pages
+to the :ref:`class reference <doc_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,

+ 3 - 1
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_*

+ 1 - 1
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 <https://github.com/godotengine/godot>`_. We generate
-             the :ref:`Godot API <toc-class-ref>` section of this documentation
+             the :ref:`Class Reference <doc_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`.

+ 2 - 2
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 <toc-class-ref>`
+The class reference is available online in the :ref:`classes <doc_class_reference>`
 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
-             <toc-class-ref>`, hosted in the `godot-docs
+             <doc_class_reference>`, hosted in the `godot-docs
              <https://github.com/godotengine/godot-docs>`_ repository.
 
 .. warning::

+ 2 - 2
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
-  <toc-class-ref>`. 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
+  <doc_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.

+ 1 - 1
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 <toc-class-ref>`
+To browse it online, head to the manual's :ref:`Class Reference <doc_class_reference>`
 section.
 
 A class reference's page tells you: