IntenseWebs/sphinx
3
0
Fork 0
mirror of https://github.com/sphinx-doc/sphinx.git synced 2025-02-25 18:55:22 -06:00
Code Issues Packages Projects Releases Wiki Activity

Conditional prefix prepending for docclasses

Browse Source 
To remove the prefix for document classes completely is not necessary. Old
style config files can still work if there is a corresponding condition which
prepends 'sphinx' only when the configured document class is one of the Sphinx
specific classes.
This commit is contained in:
Erik Bernoth 2013-09-20 11:45:56 +02:00
parent 22d3976af2
commit 804b6a0cdb
1 changed files with 11 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
sphinx/writers/latex.py
View File

@ -167,6 +167,9 @@ class LaTeXTranslator(nodes.NodeVisitor):
'transition': '\n\n\\bigskip\\hrule{}\\bigskip\n\n', 'transition': '\n\n\\bigskip\\hrule{}\\bigskip\n\n',
} }
# sphinx specific document classes
docclasses = ('howto', 'manual')
def __init__(self, document, builder): def __init__(self, document, builder):
nodes.NodeVisitor.__init__(self, document) nodes.NodeVisitor.__init__(self, document)
self.builder = builder self.builder = builder
@ -179,7 +182,7 @@ class LaTeXTranslator(nodes.NodeVisitor):
self.elements = self.default_elements.copy() self.elements = self.default_elements.copy()
self.elements.update({ self.elements.update({
'wrapperclass': document.settings.docclass, 'wrapperclass': self.format_docclass(document.settings.docclass),
'papersize': papersize, 'papersize': papersize,
'pointsize': builder.config.latex_font_size, 'pointsize': builder.config.latex_font_size,
# if empty, the title is set to the first section title # if empty, the title is set to the first section title
@ -276,6 +279,13 @@ class LaTeXTranslator(nodes.NodeVisitor):
self.previous_spanning_column = 0 self.previous_spanning_column = 0
self.remember_multirow = {} self.remember_multirow = {}
def format_docclass(self, docclass):
""" prepends prefix to sphinx document classes
"""
if docclass in self.docclasses:
docclass = 'sphinx' + docclass
return docclass
def astext(self): def astext(self):
return (HEADER % self.elements + return (HEADER % self.elements +
self.highlighter.get_stylesheet() + self.highlighter.get_stylesheet() +