Addons: Allow a user manual url prefix in doc_url

This was raised in T74017, the issue being that we point to `/dev` 
version of the manual for the addons when we want to point to a specific 
version instead.

Instead of manually updating the URL every release we can do this.

The `bl_info` for addons will need to be updated in the format of 
`'doc_url': 
{BLENDER_MANUAL_URL}/addons/import_export/scene_gltf2.html",`

Differential Revision: https://developer.blender.org/D6995
This commit is contained in:
Aaron Carlisle 2020-03-04 23:24:13 -05:00
parent ae223ff52b
commit a0ea0153c2
Notes: blender-bot 2023-02-14 19:01:06 +01:00
Referenced by issue blender/blender-addons#74017, Documentation links broken in 2.82 after recent documentation url changes for IO addons
1 changed files with 18 additions and 0 deletions

View File

@ -496,6 +496,15 @@ def disable_all():
disable(mod_name)
def _blender_manual_url_prefix():
if _bpy.app.version_cycle in {"rc", "release"}:
manual_version = "%d.%d" % _bpy.app.version[:2]
else:
manual_version = "dev"
return f"https://docs.blender.org/manual/en/{manual_version}"
def module_bl_info(mod, info_basis=None):
if info_basis is None:
info_basis = {
@ -543,5 +552,14 @@ def module_bl_info(mod, info_basis=None):
)
)
doc_url = addon_info["doc_url"]
if doc_url:
doc_url_prefix = "{BLENDER_MANUAL_URL}"
if doc_url_prefix in doc_url:
addon_info["doc_url"] = doc_url.replace(
doc_url_prefix,
_blender_manual_url_prefix(),
)
addon_info["_init"] = None
return addon_info