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

Syntax highlight API Blueprint in documentation #779

Merged
merged 1 commit into from
May 12, 2017

Conversation

kylef
Copy link
Member

@kylef kylef commented May 9, 2017

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:

screen shot 2017-05-09 at 20 04 22

Before

screen shot 2017-05-09 at 20 01 08

After

screen shot 2017-05-09 at 20 01 05

@kylef kylef mentioned this pull request May 9, 2017
@honzajavorek honzajavorek merged commit 524e3d9 into master May 12, 2017
@honzajavorek honzajavorek deleted the kylef/apib-lexer branch May 12, 2017 12:09
@honzajavorek
Copy link
Contributor

Thanks! Let's see how the result of the build will look like 👍

@honzajavorek
Copy link
Contributor

Looks great!

image

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants