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.

Sign up for GitHub

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

Jump to bottom

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

Open
amlannandy opened this issue Feb 25, 2021 · 1 comment · May be fixed by #134
Open

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

amlannandy opened this issue Feb 25, 2021 · 1 comment · May be fixed by #134

Comments

@amlannandy
Copy link
Contributor

amlannandy commented Feb 25, 2021 •
edited
Loading

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
Copy link
Contributor Author

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

@amlannandy amlannandy linked a pull request Mar 1, 2021 that will close this issue
Open
9 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Created Auto Documentation for Backend using flask-selfdoc amlannandy/OpenMF
1 participant
@amlannandy