Syntax highlight API Blueprint in documentation #779
Merged
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 PR uses pygments-apiblueprint to add syntax highlighting for API Blueprint to the rendered documentation on readthedocs. While pygments-apiblueprint is not perfect, it is certainly better than no syntax highlighting. If you spot any rendering issues with API Blueprints feel free to open issues over there and I'll try fixing (I did find kylef/pygments-apiblueprint#1 which I'll fix but no need to block this PR).
Note, this also version locks all of the mkdocs/pygments and related dependencies so that they are not changed and break the docs. If you'd rather not lock the versions I can change requirements.txt to not specify versions, but I think it would be a good idea to lock them so documentation doesn't silently break when a version of mkdocs or dependency has a breaking change.
For readthedocs to install the dependencies declared in
docs/requirements.txt
the path must be specified on read the docs admin. Please enter it there before merging:Before
After