godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2025-12-31 17:49:03 +03:00
Code Issues Packages Projects Releases Wiki Activity

Add support for split class reference

Browse Source
This commit is contained in:
Yuri Sizov
2022-07-26 18:34:07 +03:00
parent f3227a63d0
commit a5bf20bb6d
6 changed files with 10 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
community/contributing/contributing_to_the_documentation.rst
View File

@@ -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`.

4
community/contributing/updating_the_class_reference.rst
View File

@@ -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::

4
community/contributing/ways_to_contribute.rst
View File

@@ -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.