lkml.org 
[lkml]   [2019]   [Jan]   [14]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH 2/3] docs-rst: update index file with infiniband docs
On Mon, Jan 14, 2019 at 11:00:50AM +0200, Joel Nider wrote:
> Link the previously converted Documentation/infiniband/user_verbs.rst
> to the main index by creating a new subsystem (Infiniband) under the
> root document. This manifests as a new section under "Kernel API
> Documentation" in the index.html, as well as a new section in the
> table of contents pane.
>
> This has been tested with 'make htmldocs'.
> ---

Missed signed-off-by

> Documentation/conf.py | 2 ++
> Documentation/index.rst | 1 +
> Documentation/infiniband/conf.py | 10 ++++++++++
> Documentation/infiniband/index.rst | 9 +++++++++
> 4 files changed, 22 insertions(+)
> create mode 100644 Documentation/infiniband/conf.py
> create mode 100644 Documentation/infiniband/index.rst
>
> diff --git a/Documentation/conf.py b/Documentation/conf.py
> index 72647a3..ff71088 100644
> --- a/Documentation/conf.py
> +++ b/Documentation/conf.py
> @@ -389,6 +389,8 @@ latex_documents = [
> 'ext4 Data Structures and Algorithms', 'ext4 Community', 'manual'),
> ('gpu/index', 'gpu.tex', 'Linux GPU Driver Developer\'s Guide',
> 'The kernel development community', 'manual'),
> + ('infiniband/index', 'infiniband.tex', 'Infiniband subsystem',
> + 'The kernel development community', 'manual'),
> ('input/index', 'linux-input.tex', 'The Linux input driver subsystem',
> 'The kernel development community', 'manual'),
> ('kernel-hacking/index', 'kernel-hacking.tex', 'Unreliable Guide To Hacking The Linux Kernel',
> diff --git a/Documentation/index.rst b/Documentation/index.rst
> index c858c2e..8d91ea5 100644
> --- a/Documentation/index.rst
> +++ b/Documentation/index.rst
> @@ -82,6 +82,7 @@ needed).
> core-api/index
> media/index
> networking/index
> + infiniband/index
> input/index
> gpu/index
> security/index
> diff --git a/Documentation/infiniband/conf.py b/Documentation/infiniband/conf.py
> new file mode 100644
> index 0000000..dc42d33
> --- /dev/null
> +++ b/Documentation/infiniband/conf.py
> @@ -0,0 +1,10 @@
> +# -*- coding: utf-8; mode: python -*-
> +
> +project = "Linux Infiniband Documentation"
> +
> +tags.add("subproject")
> +
> +latex_documents = [
> + ('index', 'infiniband.tex', project,
> + 'The kernel development community', 'manual'),
> +]
> diff --git a/Documentation/infiniband/index.rst b/Documentation/infiniband/index.rst
> new file mode 100644
> index 0000000..2dedc65
> --- /dev/null
> +++ b/Documentation/infiniband/index.rst
> @@ -0,0 +1,9 @@
> +Infiniband Documentation
> +========================
> +
> +Contents:
> +
> +.. toctree::
> + :maxdepth: 1
> +
> + user_verbs
> --
> 2.7.4
>

\
 
 \ /
  Last update: 2019-01-14 17:54    [W:0.066 / U:41.768 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site