All of lore.kernel.org
 help / color / mirror / Atom feed
From: "Trevor Woerner" <twoerner@gmail.com>
To: docs@lists.yoctoproject.org
Cc: Nicolas Dechesne <nicolas.dechesne@linaro.org>
Subject: Re: [docs] Possible changes to the project docs
Date: Wed, 15 Apr 2020 11:21:05 -0400	[thread overview]
Message-ID: <20200415152105.GA11838@linux-uys3> (raw)
In-Reply-To: <135fccacd4ee8a1ffe0e06f6f95c22e05dadf04a.camel@linuxfoundation.org>

On Wed 2020-04-15 @ 11:19:25 AM, Richard Purdie wrote:
> Basically, the thought is whether to move from docbook to sphinx.

This sounds like a good idea to me.

Prior to yesterday I had never looked into sphinx before. Skimming some
information about sphinx, it looks like it's flexible with regards to the
exact formatting you use for, for example, section headings. If that's true, I
believe we'll need a "coding standard" in place before proceeding. We wouldn't
want the BSP Manual to use:

	section 1
	^^^^^^^^^
	section 1.1
	===========
	section 1.1.1
	-------------

and the Reference Manual to use:

	section 1
	=========
	section 1.1
	***********
	section 1.1.1
	^^^^^^^^^^^^^

Best regards,
	Trevor

  reply	other threads:[~2020-04-15 15:21 UTC|newest]

Thread overview: 21+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2020-04-15 10:19 Possible changes to the project docs Richard Purdie
2020-04-15 15:21 ` Trevor Woerner [this message]
2020-04-16 16:51   ` [docs] " Robert P. J. Day
2020-04-16 17:00     ` Nicolas Dechesne
2020-04-16 17:46       ` Robert P. J. Day
2020-04-16 17:55         ` Nicolas Dechesne
2020-04-16 18:06           ` Robert P. J. Day
2020-05-21 20:41             ` Mark Morton
2020-05-25  7:33               ` Nicolas Dechesne
2020-05-26 10:43                 ` Nicolas Dechesne
2020-05-28  5:49                   ` Mark Van De Vyver
2020-05-28  7:54                     ` [docs] " Nicolas Dechesne
2020-05-28  8:23                       ` Robert P. J. Day
2020-05-28  8:29                       ` Robert P. J. Day
2020-05-28  8:47                         ` Nicolas Dechesne
2020-06-01  1:19                       ` Mark Van De Vyver
2020-06-12 11:52                   ` [docs] " Nicolas Dechesne
2020-06-15 19:52                     ` Nicolas Dechesne
2020-04-15 15:37 ` Nicolas Dechesne
2020-04-15 17:13   ` [docs] " akuster
2020-04-16 16:47 ` Robert P. J. Day

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=20200415152105.GA11838@linux-uys3 \
    --to=twoerner@gmail.com \
    --cc=docs@lists.yoctoproject.org \
    --cc=nicolas.dechesne@linaro.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.