linuxdoc package¶
Submodules¶
- linuxdoc.autodoc module
- linuxdoc.cdomain module
- linuxdoc.compat module
- linuxdoc.deprecated module
- linuxdoc.grepdoc module
- linuxdoc.kernel_doc module
- kernel_doc
Container
DEFAULT_EXP_IDS
DEFAULT_EXP_METHOD
ListTranslator
ListTranslator.eof()
ListTranslator.get_type()
ListTranslator.output_DOC()
ListTranslator.output_enum_decl()
ListTranslator.output_epilog()
ListTranslator.output_function_decl()
ListTranslator.output_preamble()
ListTranslator.output_prefix()
ListTranslator.output_struct_decl()
ListTranslator.output_suffix()
ListTranslator.output_typedef_decl()
ListTranslator.output_union_decl()
NullTranslator
NullTranslator.HIGHLIGHT_MAP
NullTranslator.LINE_COMMENT
NullTranslator.eof()
NullTranslator.output_DOC()
NullTranslator.output_enum_decl()
NullTranslator.output_epilog()
NullTranslator.output_function_decl()
NullTranslator.output_preamble()
NullTranslator.output_prefix()
NullTranslator.output_struct_decl()
NullTranslator.output_suffix()
NullTranslator.output_typedef_decl()
NullTranslator.output_union_decl()
ParseOptions
Parser
Parser.DOC_TYPES
Parser.LOG_FORMAT
Parser.check_return_section()
Parser.check_sections()
Parser.close()
Parser.create_parameterlist()
Parser.debug()
Parser.dump_DOC()
Parser.dump_enum()
Parser.dump_epilog()
Parser.dump_function()
Parser.dump_preamble()
Parser.dump_prefix()
Parser.dump_section()
Parser.dump_struct()
Parser.dump_suffix()
Parser.dump_typedef()
Parser.dump_union()
Parser.error()
Parser.feed()
Parser.gather_context()
Parser.info()
Parser.output_decl()
Parser.parse()
Parser.parse_dump_storage()
Parser.prepare_struct_union()
Parser.process_state3_function()
Parser.process_state3_type()
Parser.push_parameter()
Parser.reset_state()
Parser.sect_title()
Parser.section_constants
Parser.section_context
Parser.section_def
Parser.section_default
Parser.section_descr
Parser.section_intro
Parser.section_members
Parser.section_return
Parser.setOptions()
Parser.setTranslator()
Parser.special_sections
Parser.state_0()
Parser.state_1()
Parser.state_2()
Parser.state_3()
Parser.state_4()
Parser.state_5()
Parser.syscall_munge()
Parser.tracepoint_munge()
Parser.undescribed
Parser.warn()
ParserBuggy
ParserContext
RE
ReSTTranslator
ReSTTranslator.BITFIELD
ReSTTranslator.FUNC_PTR
ReSTTranslator.HEADER_TAGS
ReSTTranslator.HIGHLIGHT_MAP
ReSTTranslator.INDENT
ReSTTranslator.LINE_COMMENT
ReSTTranslator.MASK_REST_INLINES
ReSTTranslator.format_block()
ReSTTranslator.highlight()
ReSTTranslator.output_DOC()
ReSTTranslator.output_enum_decl()
ReSTTranslator.output_epilog()
ReSTTranslator.output_function_decl()
ReSTTranslator.output_preamble()
ReSTTranslator.output_prefix()
ReSTTranslator.output_struct_decl()
ReSTTranslator.output_suffix()
ReSTTranslator.output_typedef_decl()
ReSTTranslator.write_anchor()
ReSTTranslator.write_definition()
ReSTTranslator.write_func_param()
ReSTTranslator.write_header()
ReSTTranslator.write_section()
SimpleLog
TranslatorAPI
TranslatorAPI.HIGHLIGHT_MAP
TranslatorAPI.LINE_COMMENT
TranslatorAPI.comment()
TranslatorAPI.eof()
TranslatorAPI.get_epilog()
TranslatorAPI.get_preamble()
TranslatorAPI.highlight()
TranslatorAPI.output_DOC()
TranslatorAPI.output_enum_decl()
TranslatorAPI.output_epilog()
TranslatorAPI.output_function_decl()
TranslatorAPI.output_preamble()
TranslatorAPI.output_prefix()
TranslatorAPI.output_struct_decl()
TranslatorAPI.output_suffix()
TranslatorAPI.output_typedef_decl()
TranslatorAPI.output_union_decl()
TranslatorAPI.setOptions()
TranslatorAPI.setParser()
TranslatorAPI.write()
TranslatorAPI.write_comment()
highlight_parser()
map_row()
normalize_id()
normalize_ws()
openTextFile()
readFile()
- linuxdoc.kernel_include module
- linuxdoc.kfigure module
- scalable figure and image handling
KernelFigure
KernelImage
KernelRender
add_kernel_figure_to_std_domain()
convert_image()
dot2format()
file2literal()
isNewer()
kernel_figure
kernel_image
kernel_render
mkdir()
pass_handle()
setup()
setupTools()
svg2pdf()
visit_kernel_figure()
visit_kernel_image()
visit_kernel_render()
which()
- linuxdoc.lint module
- linuxdoc.manKernelDoc module
- kernel-doc-man
KernelDocMan
KernelDocManBuilder
KernelDocManBuilder.finish()
KernelDocManBuilder.format
KernelDocManBuilder.get_partial_document()
KernelDocManBuilder.init()
KernelDocManBuilder.is_manpage()
KernelDocManBuilder.name
KernelDocManBuilder.prepare_writing()
KernelDocManBuilder.supported_image_types
KernelDocManBuilder.write()
KernelDocManBuilder.write_doc()
Section2Manpage
kernel_doc_man
setup()
skip_kernel_doc_man()
- linuxdoc.rest module
- linuxdoc.rstFlatTable module
- linuxdoc.rstKernelDoc module
Module contents¶
The LinuxDoc library contains Sphinx-doc extensions and command line tools related to the build process of the Linux-Kernel documentation. Even if this project started in context of the Linux-Kernel documentation, you can use these extensions in common Sphinx-doc projects.
- copyright:
Copyright (C) 2018 Markus Heiser
- e-mail:
- license:
AGPL-3.0-or-later; see LICENSE for details.
- docs:
- repository: