-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Replace JSDoc as it is no longer maintained #46
Comments
Thanks, I'll take a look at it. We definitely want to move away from JSDoc, so it might be a good option. |
Hi @ShukantPal, I actually tried to use webdoc with this repo today and I'm getting a whole bunch of warnings and error messages when trying it with the default config described here. Here's the output: webdoc-output.txt I understand that we're probably not using valid JSDoc in all places, but other tools at least succeed to build a documentation. (For example, I also tried out documentation.js which succeeds without complaining.) Also, I was hoping that a newer, maintained documentation tool will finally get rid of our |
@stefandesu Thanks for testing it out. Can you publish the branch so I can fix these problems? I'll look into the audit warnings - I assume JSDoc would have them too at this point though. |
Published it here: https://github.com/gbv/cocoda-sdk/tree/webdoc Thanks for looking into it! Yeah, JSDoc (and the better-docs theme) also have several audit warnings. I guess a documentation generator is fairly complex and it's difficult to minimize the dependencies. |
Hi folks, JSDoc is no longer being actively maintained and that's why I built a better, maintainable toolset called webdoc. webdoc has a more modern theme that's fully customizable! I would be down to helping you move your documentation to webdoc, the choice is up to you.
The text was updated successfully, but these errors were encountered: