Skip to content

Adopt a Documentation Generator for use with Moja Global #123

@HarshCasper

Description

@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

Metadata

Metadata

Assignees

No one assigned

    Labels

    P0High priority issue

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions