This repository was archived by the owner on Mar 7, 2025. It is now read-only.
Added Automatic Documentation #206
Closed
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.
Hello to the team at Hack4Impact! I was really inspired by the work your team has been doing, and I was especially impressed at how your team is solving real world problems, and I noticed that your team built this incredible flask boilerplate that empowers everyone to create a impact.
I've been contributing to the Optic Project and helped write integration guides on how you can use it on various API frameworks in the past, and wanted to go a step further by PR-ing my work into awesome boilerplates. Using the boilerplate, I wanted to add a way for the documentation to update as I modified it, so I added Optic. Finding it helpful, I thought it'd be really useful to contribute back and add auto docs to the project.
Did I implement this correctly?
Key Changes
manage.pyto look for theOPTIC_API_PORT(this enables optic to run) - this won't stop you from running the api like normal viahoncho)api spec)