Topic was automatically imported from the old Question2Answer platform.
Asked By
Emerson MX
Old Version
Published before Godot 3 was released.
I’m using Godot with an external editor (vim), however every time I need to see a built-in function or class I have to search the online documentation. It would also be nice if autocomplete worked for such cases.
I’m thinking of making a converter that extracts from .rst files from the documentation to .gd files. Hence the .gd files would have only dummy classes and functions (Like some IDE helpers out there). And then I could use ctags to generate the index.
Before doing this, I come here to know the opinion of the community on the subject.
If you had something more structured to work with, the conversion would be easier.
Any solution to this is going to need to be tied directly into the engine. No offense, but your suggestion to use the .rst files is a bad one. First of all, the API docs are all autogenerated anyway, so it would be an unnecessary step - you should pull directly from the source. Secondly, any changes to the .rst formatting would break your tool, so it would be a huge pain to manage.
Personally, I think integrating the Language Server Protocol or something similar is really going to be the best solution. It will be flexible and support a variety of editors. If you are able to contribute to that, I think it would be the best use of your time.
The GDNative API generator could be used as API data source, but that would still mean the external editor would need to rewrite all the completion logic.
Zylann | 2017-09-08 12:38
Yes using the .rst is really a bad idea, but it was what I had seen so far.