Project

Profile

Help

Actions
Send by e-mail Copy link

Issue #2120

closed

Docs don't build on el7 for RPM or Docker

Added by semyers over 7 years ago. Updated about 5 years ago.

Status:
CLOSED - CURRENTRELEASE
Priority:
Urgent
Assignee:
semyers
Start date:
Due date:
Estimated time:
Severity:
2. Medium
Version - Packaging:
Platform Release:
Target Release - Packaging:
OS:
RHEL 7
Triaged:
Yes
Groomed:
No
Sprint Candidate:
No
Tags:
Documentation, Easy Fix, Pulp 2
Sprint:
Quarter:

Description

An older version of pygments in EPEL 7 apparently means that we don't get to use the 'json' lexer for code blocks:

RPM:

Warning, treated as error:
/builddir/build/BUILD/pulp-rpm-2.10.1/docs/tech-reference/iso-rsync-distributor.rst:14: WARNING: Pygments lexer name u'json' is not known
make: *** [html] Error 1

Docker:

Warning, treated as error:
/builddir/build/BUILD/pulp-docker-2.1.1/docs/tech-reference/distributor.rst:182: WARNING: Pygments lexer name u'json' is not known
RPM build errors:
make: *** [html] Error 1

This prevents package builds on master, which is what 2.10 will be based on tomorrow, so it needs to be fixed immediately. Since it blocks the 2.10 release, I'm going to go ahead and triage it as an Urgent but Easy Docs Fix.

Actions
Copy link
 #1

Updated by semyers over 7 years ago

Some specifics:

EPEL 7 has pygments 1.4 in it. The JSON lexer is available in 1.5[0]. (womp womp)

My immediate solution is to use the 'text' lexer, which causes pygments to do no syntax highlighting whatsoever. (womp womp again)

[0]: http://pygments.org/docs/lexers/#pygments.lexers.data.JsonLexer

Added by semyers over 7 years ago

Revision 1abcf9b8 | View on GitHub

JSON lexer not supported on el7

fixes: #2120 https://pulp.plan.io/issues/2120

Added by semyers over 7 years ago

Revision 1abcf9b8 | View on GitHub

JSON lexer not supported on el7

fixes: #2120 https://pulp.plan.io/issues/2120

Added by semyers over 7 years ago

Revision 1abcf9b8 | View on GitHub

JSON lexer not supported on el7

fixes: #2120 https://pulp.plan.io/issues/2120

Added by semyers over 7 years ago

Revision 1abcf9b8 | View on GitHub

JSON lexer not supported on el7

fixes: #2120 https://pulp.plan.io/issues/2120

Added by semyers over 7 years ago

Revision 6d807174 | View on GitHub

JSON lexer not supported on el7

fixes: #2120 https://pulp.plan.io/issues/2120

Actions
Copy link
 #2

Updated by semyers over 7 years ago

  • Status changed from ASSIGNED to POST

I went with the even simpler solution of not using code-block. Other JSON snippets were called out with the double-colon block, so I just used that for consistency.

https://github.com/pulp/pulp_docker/pull/172
https://github.com/pulp/pulp_rpm/pull/952

Actions
Copy link
 #3

Updated by semyers over 7 years ago

  • Status changed from POST to MODIFIED
  • % Done changed from 0 to 100
Actions
Copy link
 #4

Updated by semyers over 7 years ago

  • Platform Release set to 2.10.0
Actions
Copy link
 #5

Updated by semyers over 7 years ago

  • Status changed from MODIFIED to 5
Actions
Copy link
 #6

Updated by semyers over 7 years ago

  • Status changed from 5 to CLOSED - CURRENTRELEASE
Actions
Copy link
 #7

Updated by semyers over 7 years ago

  • Platform Release deleted (2.10.0)
Actions
Copy link
 #8

Updated by bmbouter about 5 years ago

  • Tags Pulp 2 added
Actions
Send by e-mail Copy link

Also available in: Atom PDF