Skip to content

Instantly share code, notes, and snippets.

@alfredodeza

alfredodeza/how-to.txt

Last active November 18, 2024 07:55
Show Gist options
  • Save alfredodeza/7fb5c667addb1c6963b9 to your computer and use it in GitHub Desktop.
Save alfredodeza/7fb5c667addb1c6963b9 to your computer and use it in GitHub Desktop.
Download ZIP
pdf output from sphinx with rst2pdf
Raw
how-to.txt
1. Install rst2pdf
- use your package manager (or)
- pip install rst2pdf (or)
- easy_install rst2pdf
2. Add rst2pdf to the list of extensions in conf.py
extensions = ['rst2pdf.pdfbuilder']
This list will be empty if you accepted the defaults when the project was setup. If not, just append 'rst2pdf.pdfbuilder' to the list.
3. Add a pdf_documents variable to conf.py
pdf_documents = [('index', u'rst2pdf', u'Sample rst2pdf doc', u'Your Name'),]
# index - master document
# rst2pdf - name of the generated pdf
# Sample rst2pdf doc - title of the pdf
# Your Name - author name in the pdf
4. Generate pdf
sphinx-build -b pdf source build/pdf
The generated pdf will be in the build/pdf directory.
@aitesam961
Copy link

Great work listing it out.
I'm using sphinx_rtd_theme that works well with html build but the PDF build returns no theme and just the headings stuff.
Is there a way to produce ReadtheDocs theme in PDF?

Much appreciated.
Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment