kernel|doc.rst

The Linux kernel source files may contain structured documentation comments in the kernel-doc format to describe the functions, types and design of the code. It ...

Documentation/kernel-documentation.rst - kernel/common - Google Git

1. ``=`` with overline for document title:: ============== Document title. ============== · 2. ``=`` for chapters:: Chapters. ======== · 3. ``-`` for sections::.

kernel-doc.rst - Bootlin Elixir Cross Referencer - Elixir Bootlin

Elixir Cross Referencer - source code of Linux v6.11.7: Documentation/doc-guide/kernel-doc.rst.

howto.rst - The Linux Kernel Archives

rst ` This describes the Linux kernel coding style, and some of the rationale behind it. All new code is expected to follow the guidelines in this ...

linux/Documentation/process/kernel-docs.rst at master - GitHub

Documentation that comes with the kernel sources, inside the Documentation directory. Some pages from this document (including this document itself) have been ...

linux/scripts/kernel-doc at master · torvalds/linux - GitHub

See Documentation/doc-guide/kernel-doc.rst for the documentation comment syntax. =cut.

reStructuredText Primer — Sphinx documentation

reStructuredText is the default plaintext markup language used by Sphinx. This section is a brief introduction to reStructuredText (reST) concepts and syntax, ...

HelpOnParsers/ReStructuredText - Linux Kernel Newbies

ReStructuredText Parser ... ReStructuredText is an easy-to-read, what-you-see-is-what-you-get plaintext markup syntax and parser system. It is useful for in-line ...

Setting up a small Sphinx project for validating Linux kernel ...

Which is pretty nice, as rst human readable and can also be used to produce HTML, PDF and other file formats. But it means that when I make ...

Documentation/doc-guide/kernel-doc.rst - GitLab

The documentation comments may be included to any of the reStructuredText documents using a dedicated kernel-doc Sphinx directive extension. The ...

reStructuredText - Docutils

The primary goal of reStructuredText is to define and implement a markup syntax for use in Python docstrings and other documentation domains, that is readable ...

Step 1: Getting started with RST — Sphinx Tutorial 1.0 documentation

Now you need to tie all these files together. As we mentioned above, the Table of Contents Tree is the best way to do this. Go ahead and complete the toctree ...

Quick reStructuredText - Docutils

This document is just intended as a reminder. Links that look like "(details)" point into the HTML version of the full reStructuredText specification document.

rstdoc - PyPI

rst. rstdoc creates documentation (PDF, HTML, DOCX) from restructuredText (.rst, .rest) using ...

reStructuredText - Wikipedia

It is part of the Docutils project of the Python Doc-SIG (Documentation ... "PEP 287 -- reStructuredText Docstring Format". Python Software Foundation ...

reStructuredText — Sphinx documentation

reStructuredText (reST) is the default plaintext markup language used by both Docutils and Sphinx. Docutils provides the basic reStructuredText syntax, while ...

Linux Kernel Documentation / doc-guide / sphinx.rst

Documentation / doc-guide / sphinx.rst. Based on kernel version 6.11 . Page generated on 2024-09-24 08:21 EST . Download ...

[Drbd-dev] kernel-doc-rst-lint (was: Re: [PATCH 00/15] improve ...

[Drbd-dev] kernel-doc-rst-lint (was: Re: [PATCH 00/15] improve function-level documentation). Julia Lawall julia.lawall at lip6.fr. Wed Oct 5 ...

Documentation/doc-guide/kernel-doc.rst

Documentation/doc-guide/kernel-doc.rst describes syntax and useage for kernel-doc comments. Links. https://github.com/torvalds/linux/blob/ ...

Introduction to reStructuredText - Write the Docs

What is reStructuredText?: reStructuredText is a lightweight markup language that is used in static site generators like Sphinx. It contains robust tools ...