sphinx-doc/sphinx

Adding source code to Latex in a similar way that it is done in HTML

Open

#6094 aperta il 23 feb 2019

Vedi su GitHub
 (2 commenti) (0 reazioni) (0 assegnatari)Python (1985 fork)batch import
extensionshelp wantedtype:enhancement

Metriche repository

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

Descrizione

Is your feature request related to a problem? Please describe. I'm using sphinx.ext.viewcode to link the source code when I generate the html. That works well, when I press source, I can see the original code in the web page.

However, when generating the latex version, I can't add the source code in the pdf.

Describe the solution you'd like I would like to be able to have in the latex document the docstrings of my classes and a link to the original code (all in the same document).

Additional context asked in SOF

Guida contributor

Direzione di ricerca
Comprendere l'implementazione di viewcode HTML in Sphinx e adattarla per generare collegamenti al codice sorgente LaTeX.
Tech stack
python
Dominio
documentation
Tipo issue
Funzionalità
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.
In attesa del maintainer
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Chiara
Prerequisiti
PythonSphinx
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
40