-
Notifications
You must be signed in to change notification settings - Fork 33
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
Adopt a Documentation Generator for use with Moja Global #123
Comments
cc: @aornugent @gmajan |
@HarshCasper Can I close this? |
As of now its a different issue, out of scope for the GSoD Project. Let's keep it open and revisit it after sometime. |
Hi, |
Is your feature request related to a problem? Please describe.
Currently, I have not found the usage of Documentation Generator Tools in usage at Moja Global. Right now all the Documentation is hosted on the Moja Global Docs and Wiki Tabs.
Describe the solution you'd like
We can make use of a Documentation Generator like Doxygen which can automatically generate apt documentation for us by going through the Source Code and publishing the output using PDF/HTML.
According to the Official Docs of Doxygen, we can consider the following advantages for our case:
Describe alternatives you've considered
One popular alternative that we can consider is Breathe which supposedly acts as a bridge between the Sphinx and Doxygen documentation systems. Since we are already using Sphinx, it would be quite reasonable to consider Breathe as well.
Additional context
The text was updated successfully, but these errors were encountered: