Sphinx Office

This package provides you an easy to use package for creating print-ready PDF documents from reStructuredText files using Sphinx.

If you are viewing this file with Sublime Text, then you can simply run "Sphinx Office: Create Sphinx HowTo (PDF)" from command palette.


For this package to work you need following third party software:


Sphinx Office Documents can override any latex settings, which are defined in sphinx (and some more) in the first fieldset in the document. So you should typically start your document with:

Document Title

:Author: My Name

Following field names are allowed (case insensitive):

papersize a4paper a4paper, letterpaper, a5paper, etc. pointszie 12pt 10pt, 11pt, etc. basefont sans sans, times, etc

fontpkg use package specified by basefont \\usepackage{times}, \\usepackage{sans} extraclassoptions: Here you can specify more classoptions to documentclass.

'classoptions':    '',
'extraclassoptions': '',
'inputenc':        '\\usepackage[utf8]{inputenc}',
'utf8extra':       '\\DeclareUnicodeCharacter{00A0}{\\nobreakspace}',
'cmappkg':         '\\usepackage{cmap}',
'fontenc':         '\\usepackage[T1]{fontenc}',
'babel':           '\\usepackage{babel}',
'fncychap':        '\\usepackage[Bjarne]{fncychap}',
'longtable':       '\\usepackage{longtable}',
'preamble':        '',
'title':           '',
'date':            '',
'release':         '',
'author':          '',
'logo':            '',
'releasename':     'Release',
'makeindex':       '\\makeindex',
'shorthandoff':    '',
'maketitle':       '\\maketitle',
'tableofcontents': '\\tableofcontents',
'footer':          '',
'printindex':      '\\printindex',
'transition':      '\n\n\\bigskip\\hrule{}\\bigskip\n\n',


Here an example letter:

My Name, My Street, My City

Sublime HQ Pty Ltd

Place, 12. September 2013

**What a great Editor!**

Dear Sir or Madam,

I just wanted to say, that I really love this editor.  It is the
best one, I ever had.  There are three major points about SublimeText:

- Because I am a pretty old fashioned vim-user, I never could find an
  editor, which I simply could use because of the lack of

- GotoAnything Feature is the fastest file navigation I ever had.

- Great Plugin API, which lets you customize the editor to you
  your needs.


My Signature

Then run "Sphinx Office: Create DIN Brief (PDF)" from Command Palette. This will create a PDF file next to current rst file.

Well this was the convenience way for creating a letter. It is intended to interprete the most natural textual way of writing a letter as letter. Here what is automatically recognized:

Beginning of document:
  • backaddress as a one-line-paragraph separated by ","
  • address is something where all lines together are not longer than 60*line_count and at least one new-line. There may be one or two addresses. If one, then it is interpreted as recipient's address, if there are two, the first is the sender's address and the second the recipient's.
  • place and date is a single line paragraph with a "," in the line and the line ends with a four-digit year.
  • Subject is a one-line-paragraph and something emphasized either by default role `like this` or by *this* or **that** or whatever.
  • another one-line-paragraph is interpreted as opening
End of document:
  • if there is a one-line-paragraph in the end of the document, it is interpreted as signature
  • if there is another one-line-paragraph before, it is interpreted as signature

You can specify all these parameter as fields in the beginning of the letter:

:backaddress: this backaddress can be anything
:place: My Place
:date: some date
:subject: subject
:opening: Dear Sir or Madam,
:closing: Sincerly,
:signature: My Signature

Or you can even use the letter-directive:

.. letter::
    Sublime HQ Pty Ltd

    :subject: **what a great editor**

    Here the letter text.

If you specify a letter directive without letter body, these values will be taken as defaults for subsequent letter directives. Using letter directive you can create multiple letters within one document.