Add API docs generation to Figures devsite #292
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
johnbaldwin
force-pushed
the
john/add-api-docs
branch
2 times, most recently
from
43fef9b to
3745467
Compare
OpenAPI/Swagger documentation generation now included in Figures devsite. This requires running Figures devsite in "Juniper mode" with Python 3.8 (3.5 might work but not tested). See the file: `docs/soruce/api.rst` for details Also added some improvements to the environment settings * Moved the `.env` location to the same directory as `devsite/manage.py` isntead of being in the devsite main package. * Updated `.env.example` * Added more settings to be enabled by `.env` See the comments in `.env.example` for details
johnbaldwin
force-pushed
the
john/add-api-docs
branch
from
3745467 to
0b75400
Compare
OmarIthawi
approved these changes
Dec 7, 2020
| OPENEDX_RELEASE=(str, 'HAWTHORN'), | ||
| FIGURES_IS_MULTISITE=(bool, False), | ||
| ENABLE_DEVSITE_CELERY=(bool, True), | ||
| ENABLE_OPENAPI_DOCS=(bool, False), |
Contributor
There was a problem hiding this comment.
I'd lean to enable it by default in devstie/settings.py but not in prod.
Suggested change
| ENABLE_OPENAPI_DOCS=(bool, False), | |
| ENABLE_OPENAPI_DOCS=(bool, True), |
Contributor
Author
There was a problem hiding this comment.
@OmarIthawi Sure, I'll do that after I refactor juniper requirements again so that we have only the needed packages installed for the juniper tests. And there is no "prod" for Figures devsite. Right now it is a pure dev site
Contributor
Author
There was a problem hiding this comment.
I created an issue to make a mention: #294
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This was my Sunday afternoon project. I wanted to see what Swagger generated docs would look like for Figures.
OpenAPI/Swagger documentation generation now included in Figures
devsite. This requires running Figures devsite in "Juniper mode" with
Python 3.8 (3.5 might work but not tested).
See the file:
docs/soruce/api.rstfor detailsAlso added some improvements to the environment settings
.envlocation to the same directory asdevsite/manage.pyisntead of being in the devsite main package.
.env.example.envSee the comments in
.env.examplefor details