Lines Matching +full:document +full:- +full:file
1 # SPDX-License-Identifier: GPL-2.0-only
5 The Linux Kernel documentation build configuration file.
22 # Allow sphinx.ext.autodoc to document files at tools and scripts
45 dyn_exclude_patterns = ["output", "sphinx-includes"]
54 dyn_exclude_patterns.append("core-api/kho/bindings/**.yaml")
57 manpages_url = 'https://man7.org/linux/man-pages/man{section}/{page}.{section}.html'
60 # -------------------------------------------------
64 Initialize path-dependent variables
67 SOURCEDIR parameter for sphinx-build. Due to that, all patterns
134 # ------
146 # -- General configuration ------------------------------------------------
267 # source_encoding = 'utf-8-sig'
269 # The master toctree document.
290 with open("../Makefile", encoding="utf-8") as fp:
312 command-line options and find it for ourselves.
323 return c_version + "-" + c_release
336 # non-false value, then it is used:
345 # If true, '()' will be appended to :func: etc. cross-reference text.
371 # -- Options for HTML output ----------------------------------------------
392 # so a file named "default.css" will overwrite the builtin "default.css".
407 # Add color-specific RTD normal mode
411 "navigation_depth": -1,
437 # so a file named "default.css" will overwrite the builtin "default.css".
438 html_static_path = ["sphinx-static"]
441 # to typographically correct entities. However, conversion of "--" to "—"
445 # Custom sidebar templates, maps document names to template names.
448 "kernel-toc.html",
455 # The name of an image file (relative to this directory) to place at the top
460 # Output file base name for HTML help builder.
463 # -- Options for LaTeX output ---------------------------------------------
473 # Needed to generate a .ind file
477 # Don't mangle with UTF-8 chars
481 # Set document margins
492 # For CJK One-half spacing, need to be in front of hyperref
503 \input{kerneldoc-preamble.sty}
507 # This will be filled up by config-inited event
510 # The name of an image file (relative to this directory) to place at the top of
532 "sphinx/kerneldoc-preamble.sty",
536 # -- Options for manual page output ---------------------------------------
539 # (source start file, name, description, authors, manual section).
548 # -- Options for Texinfo output -------------------------------------------
550 # Grouping the document tree into Texinfo files. List of tuples
551 # (source start file, target name, title, author,
563 # -- Options for Epub output ----------------------------------------------
571 # A list of files that should not be packed into the epub file.
577 # Grouping the document tree into PDF files. List of tuples
578 # (source start file, target name, title, author, options).
582 # FIXME: Do not add the index file here; the result will be too big. Adding
583 # multiple PDF files here actually tries to get the cross-referencing right
586 ("kernel-documentation", "Kernel", "Kernel", "J. Random Bozo"),
591 # Add index link at the end of the root document for SPHINXDIRS builds.
608 rel = os.path.relpath(os.path.join(kern_doc_dir, 'sphinx-includes/subproject-index.rst'),
616 app.connect('config-inited', config_init)
617 app.connect('source-read', add_subproject_index)