Skip to content

Added static files required for swagger-ui to work #213

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
Merged
merged 4 commits into from
Apr 28, 2017
Merged

Added static files required for swagger-ui to work #213

merged 4 commits into from
Apr 28, 2017

Conversation

@brunobord
Copy link
Contributor

@brunobord brunobord commented Apr 3, 2017 •
edited
Loading

Review

This PR closes #210

  • Docs/comments - maybe add a how-to in the readme to explain how to update/upgrade the swagger static files
  • CHANGELOG.rst Updated
  • Delete your branch

@brunobord
Copy link
Contributor Author

The problem: when building the docs, RTD is running sphinx-build -b html . _build/html ; and thus, skipping the "make collectstatic" bit that was supposed to solve the pb.
It'd mean that we must tell sphinx where are the static files, and thus committing them in the repository. Sadly.

(or if you have a genius idea, I'll take it)

@mgu
Copy link
Contributor

mgu commented Apr 4, 2017

we could use swagger-ui from a CDN ?
https://cdnjs.com/libraries/swagger-ui

@brunobord
Copy link
Contributor Author

mmmm... good idea, indeed. and we wouldn't have to upgrade them, but just point at the latest? I'll try this out tomorrow.

@brunobord brunobord force-pushed the 210-fix-html-doc-swagger branch from be62b39 to 37e051a Compare April 28, 2017 09:03
@brunobord brunobord requested review from mgu and wo0dyn April 28, 2017 09:05
wo0dyn
wo0dyn approved these changes Apr 28, 2017
View reviewed changes
Copy link
Contributor

@wo0dyn wo0dyn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM. Thanks for the fix.

@brunobord
Copy link
Contributor Author

using the cdn didn't work at all, and you still need the "collecstatic" bit to be executed before building the doc with sphinx, otherwise your formidable.js won't be up-to-date.

So the doc workflow is described in the dev doc.

@brunobord brunobord merged commit e49e931 into master Apr 28, 2017
@wo0dyn wo0dyn deleted the 210-fix-html-doc-swagger branch May 10, 2017 16:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mgu mgu Awaiting requested review from mgu

1 more reviewer

@wo0dyn wo0dyn wo0dyn approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Swagger static files are 404 in the RTD documentation page

4 participants

@brunobord @mgu @wo0dyn