Fixed User module documentation is not built

JaviCervera

New member
3rd Party Module Dev
Joined
Jul 12, 2017
Messages
69
I have noticed with Vortex2 that if you put a user module under the "modules" folder and click "Help / Rebuild Help", the documentation for the module does not appear in the docs.

If you create a "modules_ext" folder, place the module there, and rebuild the documentation, it does appear.

Since Cerberus does not include a "modules_ext" folder by default anymore (at least on macOS), probably this should be fixed.
 

Martin

Active member
CX Code Contributor
3rd Party Module Dev
Tutorial Author
Joined
Jun 19, 2017
Messages
320
Oops. That modules_ext folder should be there indeed! Thanks!
 

MikeHart

Administrator
Joined
Jun 19, 2017
Messages
2,815
Everything in the path defined in the config file should be considered. Does this happen only on osx? Can you provide your sources?
 

MikeHart

Administrator
Joined
Jun 19, 2017
Messages
2,815
I have noticed with Vortex2 that if you put a user module under the "modules" folder and click "Help / Rebuild Help", the documentation for the module does not appear in the docs.

If you create a "modules_ext" folder, place the module there, and rebuild the documentation, it does appear.

Since Cerberus does not include a "modules_ext" folder by default anymore (at least on macOS), probably this should be fixed.

Hi @JaviCervera , I just tried this. Downloaded your module from Github. Renamed the folder to Vortex. In both folders, modules and modules_ext, the docs build fine. I can see a vortex entry inside the modules page. On windows and OSX.
 

MikeHart

Administrator
Joined
Jun 19, 2017
Messages
2,815
I noticed that MakeDocs didn't recognise monkey related documentation folders and files. This is fixed in the Github and will be available with the next release.
 

JaviCervera

New member
3rd Party Module Dev
Joined
Jul 12, 2017
Messages
69
I have noticed that it only happens in macOS, when it is installed in the Applications folder from the PKG installer. It looks like it has no permissions to write the doc files there. I zipped the Cerberus folder and unzipped it on my Home folder and I can run it from there without issues.
 

MikeHart

Administrator
Joined
Jun 19, 2017
Messages
2,815
I have noticed that it only happens in macOS, when it is installed in the Applications folder from the PKG installer. It looks like it has no permissions to write the doc files there. I zipped the Cerberus folder and unzipped it on my Home folder and I can run it from there without issues.

Yes, that was a different problem regarding the permissions on OSX.
 
Top Bottom