sphinx-doc/sphinx

parsed-literal output

Open

#2167 aperta il 11 dic 2015

Vedi su GitHub
 (10 commenti) (2 reazioni) (0 assegnatari)Python (1985 fork)batch import
help wantedmarkup

Metriche repository

Star
 (5625 star)
Metriche merge PR
 (Merge medio 10g 11h) (11 PR mergiate in 30 g)

Descrizione

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).

Guida contributor

Direzione di ricerca
Investiga l'implementazione della direttiva parsed literal in Sphinx per capire come viene applicata l'evidenziazione quando è presente markup inline come :ref:. Confronta i percorsi del codice per parsed literal con e senza link per identificare perché l'evidenziazione viene persa quando sono inclusi i link. Cerca casi di test pertinenti e considera l'aggiunta di un'opzione per abilitare coerentemente l'evidenziazione.
Tech stack
python
Dominio
documentationtooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
2
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-3 ore
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Attiva
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
60