sphinx-doc/sphinx

parsed-literal output

Open

#2,167 opened on Dec 11, 2015

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

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

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

Research direction
Investigate the parsed literal directive implementation in Sphinx to understand how highlighting is applied when inline markup like :ref: is present. Compare the code paths for parsed literal with and without links to identify why highlighting is lost when links are included. Look for relevant test cases and consider adding an option to consistently enable highlighting.
Tech stack
python
Domain
documentationtooling
Issue type
Bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
60