Document DJA's ability to use Compound Documents. #308
Conversation
This branch adds documentation for how to include extra resources under the `included` key. It also adds Sphinx and the extra required dependencies to build the docs to `requirements-development.txt`.
Codecov Report
@@ Coverage Diff @@
## develop #308 +/- ##
===========================================
+ Coverage 91.54% 91.63% +0.08%
===========================================
Files 49 49
Lines 2330 2330
===========================================
+ Hits 2133 2135 +2
+ Misses 197 195 -2
Continue to review full report at Codecov.
|
|
I noticed this Travis build is failing hard. I looked at the errors and they all seem to be network related (which is a relief because I'd be concerned if changing some Markdown broke the build! 😄 ). I'm guessing Travis is having some kind of outage. I would attempt to rebuild, but I don't have permission to do that. |
|
@jerel I feel a bit weird merging my own PR. Could you take a look at this? I'm trying to clear the PR queue to minimize work in progress so DRF JA doesn't feel like a log jam. Thanks! |
|
Looks good, thanks so much! |
|
Wow this was timely, I just came across the need for this while working on the backend for an ember app. I'm still a little confused on what the need is for both the "included_resources" and "included_serializers". I keep re-reading the source and the the documentation posted above, maybe I will realize what they are for once I work with it for a bit... but any clarification would be most appreciated, thanks. |
|
@n1ncha |
|
I had been doing ?included= in the querystring (which I discovered in the docs) so I wasn't seeing the difference when included_resources wasn't there. Thanks! |
This branch adds documentation for how to include extra resources
under the
includedkey.It also adds Sphinx and the extra required dependencies to build
the docs to
requirements-development.txt.I wrote this from the perspective of a user who recently encountered the need to side load extra data and had to scour the source to find it. If it's lacking in additional features that are hidden, I'd love to know and would be happy to add more.