[Backend] Create documentation for flask server using Sphinx

scorelab / OpenMF

An Open Source Mobile Forensics Investigation Tool for Android Platform

Apache License 2.0

150 stars 97 forks source link

[Backend] Create documentation for flask server using Sphinx #89

Open amlannandy opened 3 years ago

amlannandy commented 3 years ago

Is your feature request related to a problem? Please describe. The Flask API is undergoing changes frequently, and due to that the documentation for it (Readme) has to updated manually every time.

Describe the solution you'd like We can use Sphinx for auto-documenting the API. It'll save a lot of time as updating it is very easy and it'll also have a more polished look.

Describe alternatives you've considered N/A

Additional context I'd like to work on this.

amlannandy commented 3 years ago

@shivanshu1333 Hi! Please let me know your thoughts on this.