Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Print link targets in PDFs? #4

Open
jkfindeisen opened this issue Jan 24, 2017 · 1 comment
Open

Print link targets in PDFs? #4

jkfindeisen opened this issue Jan 24, 2017 · 1 comment
Labels

Comments

@jkfindeisen
Copy link
Contributor

jkfindeisen commented Jan 24, 2017

It depends on what the auto-created PDF is used for. If it is used electronically the default configuration is fine (links are clickable). If a printed manual is desired it's better to print the link targets. There are two options: right after in the text or as footnote.

See http://www.sphinx-doc.org/en/1.5.1/config.html#latex-options for configuration of latex output of sphinx (which does the pdf).

For example change latex_show_urls = False to latex_show_urls = 'footnote' in conf.py.

The auto-created pdf are at http://readthedocs.org/projects/imspectordocs/downloads/pdf/latest/.

@jkfindeisen
Copy link
Contributor Author

Another small hint. PDFs look different (and better) when created locally ("make.bat latex" then using miktex for example) than with readthedocs. For example one has line wrapes in code sections with this method but not with readthedeocs created pdfs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant