linuxdoc.autodoc module

autodoc

Implementation of the linuxdoc.autodoc command.

copyright:

Copyright (C) 2023 Markus Heiser

license:

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

The command linuxdoc.autodoc extracts the kernel-doc comments from the source code and uses them to create documentation of the source code in the reST markup:

$ linuxdoc.autodoc --help

linuxdoc.autodoc.ERR(msg)

linuxdoc.autodoc.FATAL(msg)

linuxdoc.autodoc.MSG(msg)

linuxdoc.autodoc.autodoc_file(fname)

generate documentation from fname

linuxdoc.autodoc.gather_filenames(cmd)

yield .c & .h filenames

linuxdoc.autodoc.get_cli()

linuxdoc.autodoc.insert_index_files(root_folder)

From root_folder traverse over subfolders and generate all index.rst files

linuxdoc.autodoc.main()