sphinx-doc/sphinx

parsed-literal output

Open

#2167 opened on Dec 11, 2015

View on GitHub
 (10 comments) (2 reactions) (0 assignees)Python (5,625 stars) (1,985 forks)batch import
help wantedmarkup

Description

Hi,

I have realized that the html output of parsed-literal depends on whether links are included or not. For instance:

.. parsed-literal::

   public int64  size()

will generate a single line with highlighted code

but

.. parsed-literal::

   public :ref:`fusion.flatexpr`  eval()

will yield a single line but with not highlight. Note that the link is valid and it will work nicely.

My point is: there should be a consistent behaviour. Of course would be nice to have always highlight (or an option to have it).

Contributor guide

Tech stack
python
Domain
documentation
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
PythonSphinx basics
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40
Research direction
Investigate how parsed literal directives are rendered in Sphinx's HTML writer. The issue is that highlighting works when no links are present but fails when inline links (e.g., :ref: roles) are included. Look at the rendering pipeline in sphinx/writers/html.py and the handling of parsed literal nodes. Check if the highlighter (Pygments) is applied conditionally and why links cause it to be skipped. Examine any recent changes or related issues linked in the comments.