All of lore.kernel.org
 help / color / mirror / Atom feed
From: Jonathan Corbet <corbet@lwn.net>
To: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Mauro Carvalho Chehab <mchehab@infradead.org>,
	linux-kernel@vger.kernel.org,
	Daniel Vetter <daniel.vetter@ffwll.ch>,
	Markus Heiser <markus.heiser@darmarit.de>,
	SeongJae Park <sj38.park@gmail.com>,
	Greg Kroah-Hartman <gregkh@linuxfoundation.org>,
	Masahiro Yamada <yamada.masahiro@socionext.com>,
	Nicholas Piggin <npiggin@gmail.com>
Subject: Re: [PATCH 2/6] docs-rst: update Sphinx install instructions
Date: Fri, 14 Jul 2017 09:44:02 -0600	[thread overview]
Message-ID: <20170714094402.37c0a2a2@lwn.net> (raw)
In-Reply-To: <015df5b51df69c8a9f13c79e139ee99ba8667973.1500030250.git.mchehab@s-opensource.com>

On Fri, 14 Jul 2017 08:08:19 -0300
Mauro Carvalho Chehab <mchehab@s-opensource.com> wrote:

> +Please see :ref:`sphinx_install` at the doc-guide for details about
> +Sphinx requirements.

One small comment here: formatting things this way assumes that people are
reading the documentation in a web browser.  Can we replace "at the
doc-guide" with "in Documentation/doc-guide/sphinx.rst" to improve the
usability of the plain-text files?

Otherwise the series looks good to me, thanks.

jon

  reply	other threads:[~2017-07-14 15:44 UTC|newest]

Thread overview: 9+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-07-14 11:08 [PATCH 0/6] Better document Sphinx install instructions Mauro Carvalho Chehab
2017-07-14 11:08 ` [PATCH 1/6] changes.rst: Update Sphinx minimal requirements Mauro Carvalho Chehab
2017-07-14 11:08 ` [PATCH 2/6] docs-rst: update Sphinx install instructions Mauro Carvalho Chehab
2017-07-14 15:44   ` Jonathan Corbet [this message]
2017-07-14 16:11     ` Markus Heiser
2017-07-14 11:08 ` [PATCH 3/6] sphinx.rst: explain the usage of virtual environment Mauro Carvalho Chehab
2017-07-14 11:08 ` [PATCH 4/6] sphinx.rst: fix unknown reference Mauro Carvalho Chehab
2017-07-14 11:08 ` [PATCH 5/6] sphinx.rst: describe the install requirements for kfigure Mauro Carvalho Chehab
2017-07-14 11:08 ` [PATCH 6/6] sphinx.rst: better organize the documentation about PDF build Mauro Carvalho Chehab

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=20170714094402.37c0a2a2@lwn.net \
    --to=corbet@lwn.net \
    --cc=daniel.vetter@ffwll.ch \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=markus.heiser@darmarit.de \
    --cc=mchehab@infradead.org \
    --cc=mchehab@s-opensource.com \
    --cc=npiggin@gmail.com \
    --cc=sj38.park@gmail.com \
    --cc=yamada.masahiro@socionext.com \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.