sphinx.writers.texinfo

module documentation

Custom docutils writer for Texinfo.

Unknown Field: copyright
Copyright 2007-2022 by the Sphinx team, see AUTHORS.
Unknown Field: license
BSD, see LICENSE for details.
Constant COPYING Undocumented
Constant TEMPLATE Undocumented
Variable logger Undocumented
Class ​Texinfo​Translator No class docstring; 0/1 property, 0/31 instance variable, 0/5 class variable, 9/222 methods documented
Class ​Texinfo​Writer Texinfo writer for generating Texinfo documents.
Function find​_subsections Return a list of subsections for the given section.
Function smart​_capwords Like string.capwords() but does not capitalize words that already contain a capital letter.
COPYING: str =

Undocumented

Value
'''@quotation
%(project)s %(release)s, %(date)s

%(author)s

Copyright @copyright{} %(copyright)s
@end quotation
...
TEMPLATE =

Undocumented

Value
('''\\input texinfo   @c -*-texinfo-*-
@c %%**start of header
@setfilename %(filename)s
@documentencoding UTF-8
@ifinfo
@*Generated by Sphinx '''+__display_version__)+'''.@*
@end ifinfo
@settitle %(title)s
@defindex ge
@paragraphindent %(paragraphindent)s
@exampleindent %(exampleindent)s
@finalout
...
logger =

Undocumented

def find_subsections(section):
Return a list of subsections for the given section.
Parameters
section:ElementUndocumented
Returns
List[nodes.section]Undocumented
def smart_capwords(s, sep=None):
Like string.capwords() but does not capitalize words that already contain a capital letter.
Parameters
s:strUndocumented
sep:strUndocumented
Returns
strUndocumented