Skip to content

Commit

Permalink
doc: Remove unicode prefixes
Browse files Browse the repository at this point in the history
rst2pdf only supports Python 3 now, which means the unicode string
prefix is unnecessary - strings are unicode by default in Python 3.

We also fix some formatting so people copy-pasting the configuration
into 'conf.py' files won't have to immediately resolve PEP8 issues.

Signed-off-by: Stephen Finucane <stephen@that.guru>
  • Loading branch information
stephenfin committed Jun 15, 2020
1 parent 4899f8b commit af4c411
Showing 1 changed file with 25 additions and 25 deletions.
50 changes: 25 additions & 25 deletions doc/manual.rst
Original file line number Diff line number Diff line change
Expand Up @@ -1712,7 +1712,7 @@ Sphinx_ is a very popular tool. This is the description from its website:
has excellent support for the documentation of Python projects, but other
documents can be written with it too.

rst2pdf includes an experimental PDF extension for sphinx.
rst2pdf includes an experimental PDF extension for Sphinx.

To use it in your existing Sphinx project you need to do the following:

Expand All @@ -1732,85 +1732,85 @@ To use it in your existing Sphinx project you need to do the following:
# For example: r'Guido van Rossum\\Fred L. Drake, Jr., editor'
#
# The options element is a dictionary that lets you override
# this config per-document.
# For example,
# ('index', u'MyProject', u'My Project', u'Author Name',
# dict(pdf_compressed = True))
# this config per-document. For example:
#
# ('index', 'MyProject', 'My Project', 'Author Name', {'pdf_compressed': True})
#
# would mean that specific document would be compressed
# regardless of the global pdf_compressed setting.
# regardless of the global 'pdf_compressed' setting.

pdf_documents = [
('index', u'MyProject', u'My Project', u'Author Name'),
('index', 'MyProject', 'My Project', 'Author Name'),
]

# A comma-separated list of custom stylesheets. Example:
pdf_stylesheets = ['sphinx','kerning','a4']
pdf_stylesheets = ['sphinx', 'kerning', 'a4']

# A list of folders to search for stylesheets. Example:
pdf_style_path = ['.', '_styles']

# Create a compressed PDF
# Use True/False or 1/0
# Example: compressed=True
#pdf_compressed = False
# pdf_compressed = False

# A colon-separated list of folders to search for fonts. Example:
# pdf_font_path = ['/usr/share/fonts', '/usr/share/texmf-dist/fonts/']

# Language to be used for hyphenation support
#pdf_language = "en_US"
# pdf_language = "en_US"

# Mode for literal blocks wider than the frame. Can be
# overflow, shrink or truncate
#pdf_fit_mode = "shrink"
# pdf_fit_mode = "shrink"

# Section level that forces a break page.
# For example: 1 means top-level sections start in a new page
# 0 means disabled
#pdf_break_level = 0
# pdf_break_level = 0

# When a section starts in a new page, force it to be 'even', 'odd',
# or just use 'any'
#pdf_breakside = 'any'
# pdf_breakside = 'any'

# Insert footnotes where they are defined instead of
# at the end.
#pdf_inline_footnotes = True
# pdf_inline_footnotes = True

# verbosity level. 0 1 or 2
#pdf_verbosity = 0
# pdf_verbosity = 0

# If false, no index is generated.
#pdf_use_index = True
# pdf_use_index = True

# If false, no modindex is generated.
#pdf_use_modindex = True
# pdf_use_modindex = True

# If false, no coverpage is generated.
#pdf_use_coverpage = True
# pdf_use_coverpage = True

# Name of the cover page template to use
#pdf_cover_template = 'sphinxcover.tmpl'
# pdf_cover_template = 'sphinxcover.tmpl'

# Documents to append as an appendix to all manuals.
#pdf_appendices = []
# pdf_appendices = []

# Enable experimental feature to split table cells. Use it
# if you get "DelayedTable too big" errors
#pdf_splittables = False
# pdf_splittables = False

# Set the default DPI for images
#pdf_default_dpi = 72
# pdf_default_dpi = 72

# Enable rst2pdf extension modules (default is only vectorpdf)
# you need vectorpdf if you want to use sphinx's graphviz support
#pdf_extensions = ['vectorpdf']
# pdf_extensions = ['vectorpdf']

# Page template name for "regular" pages
#pdf_page_template = 'cutePage'
# pdf_page_template = 'cutePage'

# Show Table Of Contents at the beginning?
#pdf_use_toc = True
# pdf_use_toc = True

# How many levels deep should the table of contents be?
pdf_toc_depth = 9999
Expand Down

0 comments on commit af4c411

Please sign in to comment.