linuxdoc package

Submodules

• linuxdoc.autodoc module
  • autodoc
  • ERR()
  • FATAL()
  • MSG()
  • autodoc_file()
  • gather_filenames()
  • get_cli()
  • insert_index_files()
  • main()
• linuxdoc.cdomain module
  • cdomain
  • setup()
• linuxdoc.compat module
  • compat
  • sphinx_has_c_namespace()
  • sphinx_has_c_types()
• linuxdoc.deprecated module
  • deprecated
  • cmd_kernel_autodoc()
  • cmd_kernel_doc()
  • cmd_kernel_grepdoc()
  • cmd_kernel_lintdoc()
• linuxdoc.grepdoc module
  • grep_doc
  • ERR()
  • PRINT()
  • get_cli()
  • main()
• 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
    • ParseOptions.PARSE_OPTIONS
    • ParseOptions.PARSE_OPTION_RE
    • ParseOptions.add_filters()
    • ParseOptions.dumpOptions()
    • ParseOptions.filter_opt()
    • ParseOptions.get_exported_symbols_re()
    • ParseOptions.set_defaults()
  • 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
    • ParserContext.dumpCtx()
    • ParserContext.new()
  • RE
    • RE.match()
    • RE.search()
  • 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
    • SimpleLog.LOG_FORMAT
    • SimpleLog.debug()
    • SimpleLog.error()
    • SimpleLog.info()
    • SimpleLog.warn()
  • 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
  • kernel-include
  • KernelInclude
    • KernelInclude.run()
  • setup()
• linuxdoc.kfigure module
  • scalable figure and image handling
  • KernelFigure
    • KernelFigure.run()
  • KernelImage
    • KernelImage.run()
  • KernelRender
    • KernelRender.build_node()
    • KernelRender.final_argument_whitespace
    • KernelRender.has_content
    • KernelRender.option_spec
    • KernelRender.optional_arguments
    • KernelRender.required_arguments
    • KernelRender.run()
  • 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
  • lint
  • ERR()
  • FATAL()
  • MSG()
  • get_cli()
  • lintdoc_file()
  • main()
• linuxdoc.manKernelDoc module
  • kernel-doc-man
  • KernelDocMan
    • KernelDocMan.optional_arguments
    • KernelDocMan.required_arguments
    • KernelDocMan.run()
  • 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
    • Section2Manpage.apply()
    • Section2Manpage.isolate_sections()
    • Section2Manpage.isolate_synopsis()
    • Section2Manpage.manTitleOrder
    • Section2Manpage.manTitles
    • Section2Manpage.sec2man_get_first_child()
    • Section2Manpage.strip_man_info()
  • kernel_doc_man
  • setup()
  • skip_kernel_doc_man()
• linuxdoc.rest module
  • rest
  • get_cli()
  • main()
• linuxdoc.rstFlatTable module
  • flat-table
  • FlatTable
    • FlatTable.option_spec
    • FlatTable.run()
  • ListTableBuilder
    • ListTableBuilder.buildTableNode()
    • ListTableBuilder.buildTableRowNode()
    • ListTableBuilder.parseCellItem()
    • ListTableBuilder.parseFlatTableNode()
    • ListTableBuilder.parseRowItem()
    • ListTableBuilder.pprint()
    • ListTableBuilder.raiseError()
    • ListTableBuilder.roundOffTableDefinition()
  • c_span()
  • colSpan
  • r_span()
  • rowSpan
  • setup()
• linuxdoc.rstKernelDoc module
  • rstKernelDoc
  • FaultyOption
  • KernelDoc
    • KernelDoc.errMsg()
    • KernelDoc.final_argument_whitespace
    • KernelDoc.getNodes()
    • KernelDoc.getParserOptions()
    • KernelDoc.option_spec
    • KernelDoc.optional_arguments
    • KernelDoc.parseSource()
    • KernelDoc.required_arguments
    • KernelDoc.run()
  • KernelDocParser
    • KernelDocParser.debug()
    • KernelDocParser.error()
    • KernelDocParser.info()
    • KernelDocParser.warn()
  • PARSER_CACHE
  • ParserCache
    • ParserCache.get()
    • ParserCache.get_id()
    • ParserCache.set()
  • WriterList
    • WriterList.flush()
    • WriterList.write()
  • setup()

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:

markus.heiser@darmarIT.de

license:

AGPL-3.0-or-later; see LICENSE for details.

docs:

http://return42.github.io/linuxdoc

repository:

github return42/linuxdoc