From: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
To: Jani Nikula <jani.nikula@linux.intel.com>
Cc: Linux Doc Mailing List <linux-doc@vger.kernel.org>,
Mauro Carvalho Chehab <mchehab@infradead.org>,
linux-kernel@vger.kernel.org, Jonathan Corbet <corbet@lwn.net>
Subject: Re: [PATCH] docs: hwmon: convert three docs to ReST format
Date: Thu, 18 Apr 2019 15:10:28 -0300 [thread overview]
Message-ID: <20190418151028.341723f7@coco.lan> (raw)
In-Reply-To: <87k1frgysq.fsf@intel.com>
Em Thu, 18 Apr 2019 17:42:29 +0300
Jani Nikula <jani.nikula@linux.intel.com> escreveu:
> On Thu, 18 Apr 2019, Mauro Carvalho Chehab <mchehab+samsung@kernel.org> wrote:
> > Those three new drivers were missed on the initial conversion
> > to ReST format. So:
> >
> > - Rename them to .rst;
> > - Add them to the hwmon index.rst index;
> > - add some blank lines at the "Supported systems:" part, in
> > order to allow Sphinx to properly identify new lines,
> > suppressing warnings and avoid it to output some random
> > lines in bold;
> > - When multiple authors are involved, change the authors
> > part to a list, in order to avoid adding blank lines.
> > - adjust the table cells (one of the tables seemed to be
> > assuming that tab is 4 positions instead of 8) and add
> > the table markup.
> > - be sure that the section markups have the same number of
> > characters as the section title.
> >
> > Signed-off-by: Mauro Carvalho Chehab <mchehab+samsung@kernel.org>
> > ---
> > Documentation/hwmon/index.rst | 3 +++
> > Documentation/hwmon/{ir38064 => ir38064.rst} | 21 ++++++++++++-------
> > .../hwmon/{isl68137 => isl68137.rst} | 16 ++++++++++----
> > .../hwmon/{lochnagar => lochnagar.rst} | 7 +++++--
> > 4 files changed, 33 insertions(+), 14 deletions(-)
> > rename Documentation/hwmon/{ir38064 => ir38064.rst} (76%)
> > rename Documentation/hwmon/{isl68137 => isl68137.rst} (85%)
> > rename Documentation/hwmon/{lochnagar => lochnagar.rst} (93%)
> >
> > diff --git a/Documentation/hwmon/index.rst b/Documentation/hwmon/index.rst
> > index 893804414510..3fa14fe7b49c 100644
> > --- a/Documentation/hwmon/index.rst
> > +++ b/Documentation/hwmon/index.rst
> > @@ -65,6 +65,8 @@ Hardware Monitoring Kernel Drivers
> > ina2xx.rst
> > ina3221.rst
> > ir35221.rst
> > + ir38064.rst
> > + isl68137.rst
>
> Didn't notice it on the first patch adding index.rst, but I don't think
> it's customary to add .rst suffix to the toctree.
Provided that all documents are at the same time, I guess it
doesn't matter having a .rst there or not.
Btw, newer versions of Sphinx build can work with other formats
like markdown. I suspect that, if we end mixing markdown documents,
it would be worth having the extension there.
FYI, someone recently added a markdown file at the tree:
commit e453fa60e086786fe89ba15ee8fef80bc2e6ecc3
Author: Sascha Hauer <s.hauer@pengutronix.de>
Date: Fri Sep 7 14:36:46 2018 +0200
Documentation: ubifs: Add authentication whitepaper
Documentation/filesystems/ubifs-authentication.md
IMO, the best would be to just run pandoc into it and convert
to .rst, than to mix different markup languages.
Thanks,
Mauro
next prev parent reply other threads:[~2019-04-18 18:18 UTC|newest]
Thread overview: 7+ messages / expand[flat|nested] mbox.gz Atom feed top
2019-04-18 9:40 [PATCH] docs: hwmon: convert three docs to ReST format Mauro Carvalho Chehab
2019-04-18 14:42 ` Jani Nikula
2019-04-18 18:10 ` Mauro Carvalho Chehab [this message]
2019-04-19 10:12 ` Jani Nikula
2019-04-19 10:27 ` Mauro Carvalho Chehab
2019-04-22 17:39 Mauro Carvalho Chehab
2019-04-22 22:28 ` Guenter Roeck
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=20190418151028.341723f7@coco.lan \
--to=mchehab+samsung@kernel.org \
--cc=corbet@lwn.net \
--cc=jani.nikula@linux.intel.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=mchehab@infradead.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 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.