Created Auto Documentation for Backend using flask-selfdoc #134
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Created auto-documentation for the server using self-doc.
One can view the documentation by going to the root route of the server. i.e localhost:5000/
Now, whenever a new route is created. We just have to add the self-doc decorator to it and it'll be shown in the documentation. We can also add a description to the route by using doc strings for that route's function.
Fixes #89
Type of change
How Has This Been Tested?
Shown in Demo Video
Test Configuration:
Slow.down.or.speed.up.a.video.-.change.video.speed.-.screen-capture.3.mp4.mp4
Checklist: