sphinx-doc/sphinx

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

Open

#6,094 opened on Feb 23, 2019

View on GitHub
 (2 comments) (0 reactions) (0 assignees)Python (1,985 forks)batch import
extensionshelp wantedtype:enhancement

Repository metrics

Stars
 (5,625 stars)
PR merge metrics
 (Avg merge 10d 11h) (11 merged PRs in 30d)

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

Contributor guide

Research direction
Understand the HTML viewcode implementation in Sphinx and adapt it to generate LaTeX source code links.
Tech stack
python
Domain
documentation
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Needs maintainer response
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
PythonSphinx
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
40