Open
Conversation
updated stylesheet for this fix in config to load user-documentation
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
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.
It seems to be useful to add a written description to the automatically generated documentation in some cases.
For example you might want to add a hint, that a certain resource or method need authorization, or you describe the special meaning of a field or resource...
In any case, I found it important that such documentation can be added to the code directly at the location of the data-model/schema-definition.
The proposed solution is a dict as described in the README of this request, which can be defined at any point in the code and loaded into the config before starting the eve-app. (In one project i used to define the dict directly in the SQLAlchemy-Model and was then loading the description together with the schema into the config. In small eve-projects, it can just be defined in the settings.py as shown in the example).
Important to notice: This additional description is non-mandatory, eve-docs keeps working as before. Just in case a developer wants to add a description this addition enables him/her to do so.
I added screenshots to the README and into the repository for a quick view on the example.
