sphinx-doc/sphinx

parsed-literal output

Open

#2.167 aberto em 11 de dez. de 2015

Ver no GitHub
 (10 comments) (2 reactions) (0 assignees)Python (1.985 forks)batch import
help wantedmarkup

Métricas do repositório

Stars
 (5.625 stars)
Métricas de merge de PR
 (Mesclagem média 10d 11h) (11 fundiu PRs em 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).

Guia do colaborador

Direção de pesquisa
Investigue a implementação da diretiva parsed literal no Sphinx para entender como o destaque é aplicado quando há marcação inline como :ref:. Compare os caminhos de código para parsed literal com e sem links para identificar por que o destaque é perdido quando os links são incluídos. Procure casos de teste relevantes e considere adicionar uma opção para ativar o destaque de forma consistente.
Pilha de tecnologia
python
Domain
documentationtooling
Tipo Issue
Bug
DifficultyDificuldade de implementação estimada para um novo contribuidor, de 1 para alterações muito pequenas a 5 para trabalho de nível especializado.
2
Tempo estimadoUm intervalo de tempo aproximado para um colaborador experiente investigar, implementar, testar e preparar um pull request.
1-3 horas
Status da atividadeQuão disponível o issue aparece agora: novo, ativo, obsoleto, bloqueado ou aguardando entrada do mantenedor.
Ativo
ClarityCom que clareza o issue explica a mudança esperada, os critérios de aceitação e a próxima etapa.
Claro
Prerequisites
PythonSphinx
Simpatia para novatosUma pontuação de 1 a 100 que estima o quão acessível este issue é para colaboradores iniciantes.
60