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

Add interactive docs error template #5548

merged 1 commit into from Nov 6, 2017


Copy link

@carltongibson carltongibson commented Oct 31, 2017

Closes #5496

Adds a plain error template for DocumentationRenderer.

Previously we've not had to switch template for the error case, since both cases are presented the same. With the interactive docs we need to switch to a different template. (We do this by checking whether we have a coreapi.Document, as expected, or not.)

I've not added any styling here. For the 90% case seeing this template is a configuration error, so I've added DEBUG-only notes for explaining that.

Those that need a better template can easily override in their own projects.

We can happily take PRs improving this template, but I'd rather leave that for community input at this point.

@carltongibson carltongibson added this to the 3.7.2 milestone Oct 31, 2017
@carltongibson carltongibson requested a review from tomchristie Oct 31, 2017
@carltongibson carltongibson removed the request for review from tomchristie Nov 6, 2017
@carltongibson carltongibson merged commit 565c722 into encode:master Nov 6, 2017
1 check passed
@carltongibson carltongibson deleted the 372/doc-error-rendering branch Nov 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
None yet
None yet

Successfully merging this pull request may close these issues.

None yet

1 participant