godotengine/godot-docs
1
0
Fork 0
mirror of https://github.com/godotengine/godot-docs.git synced 2026-01-07 02:12:07 +03:00
Code Issues Packages Projects Releases Wiki Activity

Document how to build the reference documentation

Browse Source 
Helps with #2417.
This commit is contained in:
Mitch Curtis
2019-04-29 18:09:51 +02:00
parent 6a7597bb75
commit 6bd56df96c
1 changed files with 2 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
community/contributing/updating_the_class_reference.rst
View File

@@ -160,6 +160,8 @@ Edit the file for your chosen class in ``doc/classes/`` to update the class refe
Edit it using your favourite text editor. If you use a code editor, make sure that it doesn't change the indent style: tabs for the XML, and 4 spaces inside BBcode-style blocks. More on that below.
If you need to check that the modifications you've made are correct in the generated documentation, build Godot as described :ref:`here <toc-devel-compiling>`, run the editor and open the help for the page you modified.
How to write the class reference
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~