What do I need to do to "register" 'latexpdf' for Sphinx?

latex python-sphinx pdflatex
orome picture orome · Jan 29, 2014 · Viewed 7k times · Source

When I run Sphinx using 'latexpdf' I get an error, even though I have a complete working TeX installation on my machine:

Sphinx error: Builder name latexpdf not registered

What do I need to do to "register" latexpdf?

Answer

mzjn picture mzjn · Jan 29, 2014

latexpdf is not a Sphinx builder; it is the name of a target in the Makefile created by sphinx-quickstart. This target uses the latex builder.

Executing sphinx-build -b latexpdf . _build produces the error in the question (as expected).

If you run make latexpdf, it works.

PyCharm was mentioned in a comment and the problem seems to stem from that program. The following is run when latexpdf is configured as a "Command" (Sphinx task): 

sphinx_runner.py -b latexpdf <indir> <outdir>

The sphinx_runner.py script is very similar to sphinx_build (a wrapper for sphinx.cmdline.main()). Since the -b option is supposed provide the name of an actual builder, there is an error.

Related questions

Sphinx docs: Remove blank pages from generated PDFs?

By default, Sphinx documentation outputs a PDF that's formatted for duplex printing. So there is a blank page between the title page and the TOC, the TOC and the introduction, the introduction and the first section, etc. My users are …

Read More
sphinx customization of latexpdf output?

Just curious if anyone knows how to customize the sphinx output when using the latexpdf target? I've seen lots of custom stuff for html output, but cant seem to find any example of custom pdf output. Specifically, I'd be interested …

Read More
Inserting a PDF file in LaTeX

I am trying to insert a PDF or doc file as an appendix in my LaTeX file. Do you know how I can do this?

Read More