Relintai/material-maker
1
0
Fork 0
mirror of https://github.com/Relintai/material-maker.git synced 2024-11-13 06:27:18 +01:00
Code Issues Packages Projects Releases Wiki Activity

Improve the "User manual" button

Browse Source 
The new behavior of `show_doc()` is as follows:

- Try to open packaged documentation first.
- If the above fails, try to open locally-built documentation
  (useful during development).
- If it still fails, try to open the online version.

This also improves path handling to be smarter.
This commit is contained in:
Hugo Locurcio 2019-10-19 01:46:25 +02:00
parent d3e34d42cb
commit 40ff89846b
No known key found for this signature in database
GPG Key ID: 39E8F8BE30B0A49C
1 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
addons/material_maker/main_window.gd
View File

@ -333,12 +333,26 @@ func save_user_library():
library.save_library("user://library/user.json") library.save_library("user://library/user.json")
func show_doc(): func show_doc():
var doc_path = OS.get_executable_path() var base_dir = OS.get_executable_path().replace("\\", "/").get_base_dir()
doc_path = doc_path.replace("\\", "/")
doc_path = doc_path.left(doc_path.rfind("/")+1)+"doc/index.html" # In release builds, documentation is expected to be located in
# a subdirectory of the program directory
var release_doc_path = base_dir.plus_file("doc/index.html")
# In development, documentation is part of the project files.
# We can use a globalized `res://` path here as the project isn't exported.
var devel_doc_path = ProjectSettings.globalize_path("res://addons/material_maker/doc/_build/html/index.html")
var file = File.new() var file = File.new()
if file.exists(doc_path): if file.file_exists(release_doc_path):
OS.shell_open(doc_path) # Open local prebuilt documentation (used in release builds)
OS.shell_open(release_doc_path)
elif file.file_exists(devel_doc_path):
# Open local documentation built from source (used during development)
OS.shell_open(devel_doc_path)
else:
# Open online documentation
OS.shell_open("https://rodzill4.github.io/godot-procedural-textures/doc/")
func bug_report(): func bug_report():
OS.shell_open("https://github.com/RodZill4/godot-procedural-textures/issues") OS.shell_open("https://github.com/RodZill4/godot-procedural-textures/issues")