Skip to content
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

Created Auto Documentation for Backend using flask-selfdoc #134

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

amlannandy
Copy link
Contributor

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

  • New feature (non-breaking change which adds functionality)

How Has This Been Tested?

Shown in Demo Video

Test Configuration:

  • Windows 10
  • Google Chrome
Slow.down.or.speed.up.a.video.-.change.video.speed.-.screen-capture.3.mp4.mp4

Checklist:

  • My code follows the style guidelines of this project
  • I have performed a self-review of my own code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes
  • Any dependent changes have been merged and published in downstream modules

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Backend] Create documentation for flask server using Sphinx
1 participant