mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: Linux Doc Mailing List <linux-doc@vger.kernel.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	Markus Heiser <markus.heiser@darmarit.de>,
	Jonathan Corbet <corbet@lwn.net>,
	Jani Nikula <jani.nikula@linux.intel.com>,
	LKML <linux-kernel@vger.kernel.org>,
	Markus Heiser <markus.heiser@darmarit.de>,
	Mauro Carvalho Chehab <mchehab@kernel.org>
Subject: [PATCH v2 20/20] doc: Add the development-process to Sphinx build
Date: Mon, 12 Sep 2016 23:18:11 -0300	[thread overview]
Message-ID: <aa550b77e920e41d3d7681bb4e30c4567bd51db6.1473732263.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <cover.1473732263.git.mchehab@s-opensource.com>
In-Reply-To: <cover.1473732263.git.mchehab@s-opensource.com>

Add an index and put it at Documentation/index.rst, in order
to allow building the Kernel develpment documentation on Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/conf.py                       |  2 ++
 Documentation/development-process/conf.py   | 10 ++++++++++
 Documentation/development-process/index.rst | 31 +++++++++++++++++++++++++++++
 Documentation/index.rst                     |  1 +
 4 files changed, 44 insertions(+)
 create mode 100644 Documentation/development-process/conf.py
 create mode 100644 Documentation/development-process/index.rst

diff --git a/Documentation/conf.py b/Documentation/conf.py
index c25e95d46272..bf6f310e5170 100644
--- a/Documentation/conf.py
+++ b/Documentation/conf.py
@@ -338,6 +338,8 @@ latex_elements = {
 latex_documents = [
     ('kernel-documentation', 'kernel-documentation.tex', 'The Linux Kernel Documentation',
      'The kernel development community', 'manual'),
+    ('development-process/index', 'development-process.tex', 'Linux Kernel Development Documentation',
+     'The kernel development community', 'manual'),
     ('gpu/index', 'gpu.tex', 'Linux GPU Driver Developer\'s Guide',
      'The kernel development community', 'manual'),
     ('media/index', 'media.tex', 'Linux Media Subsystem Documentation',
diff --git a/Documentation/development-process/conf.py b/Documentation/development-process/conf.py
new file mode 100644
index 000000000000..4b4a12dace02
--- /dev/null
+++ b/Documentation/development-process/conf.py
@@ -0,0 +1,10 @@
+# -*- coding: utf-8; mode: python -*-
+
+project = 'Linux Kernel Development Documentation'
+
+tags.add("subproject")
+
+latex_documents = [
+    ('index', 'development-process.tex', 'Linux Kernel Development Documentation',
+     'The kernel development community', 'manual'),
+]
diff --git a/Documentation/development-process/index.rst b/Documentation/development-process/index.rst
new file mode 100644
index 000000000000..f4bf8f714298
--- /dev/null
+++ b/Documentation/development-process/index.rst
@@ -0,0 +1,31 @@
+Linux Kernel Development Documentation
+======================================
+
+Contents:
+
+.. toctree::
+   :numbered:
+   :maxdepth: 2
+
+   HOWTO
+   Changes
+   CodingStyle
+   SubmittingPatches
+   SubmittingDrivers
+   stable_api_nonsense
+   SecurityBugs
+   ManagementStyle
+   stable_kernel_rules
+   kernel-docs
+   applying-patches
+
+   development-process
+
+.. only::  subproject
+
+   Indices
+   =======
+
+   * :ref:`genindex`
+
+
diff --git a/Documentation/index.rst b/Documentation/index.rst
index 05eded59820e..c6cf3971788d 100644
--- a/Documentation/index.rst
+++ b/Documentation/index.rst
@@ -12,6 +12,7 @@ Contents:
    :maxdepth: 2
 
    kernel-documentation
+   development-process/index
    dev-tools/tools
    media/index
    gpu/index
-- 
2.7.4

      parent reply	other threads:[~2016-09-13  2:19 UTC|newest]

Thread overview: 22+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-09-13  2:17 [PATCH v2 00/20] Create a book for Kernel development Mauro Carvalho Chehab
2016-09-13  2:17 ` [PATCH v2 01/20] docs-rst: move HOWTO and mentioned documents to a separate dir Mauro Carvalho Chehab
2016-09-13  2:17 ` [PATCH v2 02/20] docs-rst: HOWTO.rst: convert to ReST notation Mauro Carvalho Chehab
2016-09-13  2:17 ` [PATCH v2 03/20] docs-rst: applying-patches.rst: convert it to ReST markup Mauro Carvalho Chehab
2016-09-13  2:17 ` [PATCH v2 04/20] docs-rst: Changes.rst: " Mauro Carvalho Chehab
2016-09-13  2:17 ` [PATCH v2 05/20] docs-rst: CodingStyle.rst: Convert " Mauro Carvalho Chehab
2016-09-13  2:59   ` Joe Perches
2016-09-13  8:46     ` Mauro Carvalho Chehab
2016-09-13  2:17 ` [PATCH v2 06/20] CodingStyle.rst: use the proper tag for verbatim font Mauro Carvalho Chehab
2016-09-13  2:17 ` [PATCH v2 07/20] CodingStyle.rst: replace underline markups Mauro Carvalho Chehab
2016-09-13  2:17 ` [PATCH v2 08/20] CodingStyle.rst: use the .. note:: markup where needed Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 09/20] kernel-docs.rst: convert it to ReST markup Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 10/20] ManagementStyle.rst: " Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 11/20] SecurityBugs.rst: " Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 12/20] stable_api_nonsense.rst: " Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 13/20] stable_kernel_rules.rst: " Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 14/20] SubmittingDrivers.rst: " Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 15/20] SubmittingPatches.rst: " Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 16/20] HOWTO.rst: add cross-references to other documents Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 17/20] doc: development-process: rename files to rst Mauro Carvalho Chehab
2016-09-13  2:18 ` [PATCH v2 18/20] doc: development-process: convert it to ReST markup Mauro Carvalho Chehab
2016-09-13  2:18 ` Mauro Carvalho Chehab [this message]

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=aa550b77e920e41d3d7681bb4e30c4567bd51db6.1473732263.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=jani.nikula@linux.intel.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markus.heiser@darmarit.de \
    --cc=mchehab@infradead.org \
    --cc=mchehab@kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox

all inboxes | Powered by JetHome®