Stowage/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-10-19 07:53:26 +00:00
Code Issues Projects Releases Packages Wiki Activity

Allow dehardcoding documentation branch and URL in docs links

Browse source 
This makes it possible to change the branch of the documentation that
URLs are pointing to without having to modify all class reference
files.

In the XML class reference, the `$DOCS_URL` placeholder should be used,
and will be replaced automatically in the editor and when generating
the RST class reference.

The documentation branch string is set in `version.py`.

Co-authored-by: Hugo Locurcio <hugo.locurcio@hugo.pro>
(cherry picked from commit 5341e6010e)
This commit is contained in:
Rémi Verschelde 2021-11-15 10:39:00 +01:00
parent 175870ccc7
commit 0cdcf1154f
No known key found for this signature in database
GPG key ID: C3336907360768E1
6 changed files with 40 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

2
methods.py
View file

@ -88,6 +88,8 @@ def update_version(module_version_string=""):
f.write('#define VERSION_MODULE_CONFIG "' + str(version.module_config) + module_version_string + '"\n')
f.write("#define VERSION_YEAR " + str(version.year) + "\n")
f.write('#define VERSION_WEBSITE "' + str(version.website) + '"\n')
f.write('#define VERSION_DOCS_BRANCH "' + str(version.docs) + '"\n')
f.write('#define VERSION_DOCS_URL "https://docs.godotengine.org/en/" VERSION_DOCS_BRANCH\n')
f.close()
# NOTE: It is safe to generate this file here, since this is still executed serially