Adopt a Documentation Generator for use with Moja Global

[HarshCasper]

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:

• Helps track Document revision history and versioning.
• Generate online documentation browser even from undocumented code.
• Brings a centralized knowledge base to help new contributors to get started.
• Helps new contributors to get started up.

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

• Doxygen
• Breathe

[HarshCasper]

cc: @aornugent @gmajan

[gmajan]

@sabitarao

[sarthakkundra]

@HarshCasper Can I close this?

[HarshCasper]

@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.

[stale[bot]]

Hi, Thanks for raising an issue! We at moja global appreciate your concerns and views to help us improve. We capitalize on fostering a welcoming environment for all our contributors. This issue has not seen any activity for the past 30 days. If this Issue would not see any further updates in the next 7 days, it would be automatically closed. Please comment on the issue if you would like to discuss on this further. We truly appreciate your contributions and would love to hear your thoughts on the same!