ipython/ipython

ipython Sphinx directive executes code when excluded by only, ifconfig

Chiusa

#9339 aperta il 21 mar 2016

Vedi su GitHubGuida contributor
 (3 commenti) (1 reazione) (0 assegnatari)Python (4400 fork)batch import
good first issuehelp wanted

Metriche repository

Star
 (16.095 stelle)
Metriche merge PR
 (Metriche PR in attesa)

Descrizione

The ipython directive for Sphinx provided by IPython.sphinxext.ipython_directive executes its code block at the parsing stage. As a result, even if an ipython directive is surrounded by an only or ifconfig directive with a false-y condition, the code block is still executed. I have posted a minimum working example for this issue that includes a Sphinx configuration file and a reStructuredText file to reproduce the problem.

Guida contributor

Direzione di ricerca
La direttiva Sphinx ipython in IPython/sphinxext/ipython directive.py esegue il codice al momento del parsing, ignorando le condizioni `only` e `ifconfig`. Per risolvere il problema, l'esecuzione del codice dovrebbe essere rinviata alla fase di risoluzione del doctree, oppure la direttiva dovrebbe verificare la condizione dell'ambiente prima di eseguire. Il gist fornito (https://gist.github.com/cgranade/3cc6b87c8efef89d54b5) riproduce il problema e può essere utilizzato per i test. Inizia esaminando il metodo `run` della direttiva e la funzione `exec code` in quel file.
Tech stack
python
Dominio
documentationtooling
Tipo issue
Bug
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
Mezza giornata
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
Nessuno
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
65