sphinx-doc/sphinx

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

Open

#6 094 ouverte le 23 févr. 2019

Voir sur GitHub
 (2 commentaires) (0 réactions) (0 assignés)Python (1 985 forks)batch import
extensionshelp wantedtype:enhancement

Métriques du dépôt

Stars
 (5 625 stars)
Métriques de merge PR
 (Merge moyen 10j 11h) (11 PRs mergées en 30 j)

Description

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

Guide contributeur

Direction de recherche
Comprenez l'implémentation de viewcode HTML dans Sphinx et adaptez la pour générer des liens de code source LaTeX.
Stack technique
python
Domaine
documentation
Type d'issue
Fonctionnalité
DifficultéDifficulté estimée pour un nouveau contributeur, de 1 pour un très petit changement à 5 pour un travail expert.
2
Temps estiméFourchette de temps approximative pour investiguer, implémenter, tester et préparer une pull request.
1-3 heures
Statut d'activitéDisponibilité apparente de l'issue : fraîche, active, ancienne, bloquée ou en attente d'un mainteneur.
En attente d'un mainteneur
ClartéClarté avec laquelle l'issue explique le changement attendu, les critères d'acceptation et la prochaine étape.
Claire
Prérequis
PythonSphinx
Accessibilité débutantScore de 1 à 100 estimant l'accessibilité de cette issue pour un premier contributeur.
40