All of lore.kernel.org
 help / color / mirror / Atom feed
From: Andrew Cooper <andrew.cooper3@citrix.com>
To: Wei Liu <wei.liu2@citrix.com>
Cc: "Lars Kurth" <lars.kurth@citrix.com>,
	"Stefano Stabellini" <sstabellini@kernel.org>,
	"Konrad Rzeszutek Wilk" <konrad.wilk@oracle.com>,
	"George Dunlap" <George.Dunlap@eu.citrix.com>,
	Xen-devel <xen-devel@lists.xen.org>,
	"Julien Grall" <julien.grall@arm.com>,
	"Jan Beulich" <JBeulich@suse.com>,
	"Ian Jackson" <ian.jackson@citrix.com>,
	"Roger Pau Monné" <roger.pau@citrix.com>
Subject: Re: [PATCH 0/3] docs: User oriented documentation
Date: Wed, 20 Mar 2019 11:23:57 +0000	[thread overview]
Message-ID: <7bd031df-b291-e9f9-3566-4fb02844eb06@citrix.com> (raw)
In-Reply-To: <20190320112036.GP14641@zion.uk.xensource.com>

On 20/03/2019 11:20, Wei Liu wrote:
> On Tue, Mar 19, 2019 at 04:20:04PM +0000, Andrew Cooper wrote:
>> This is a project I've been musing over for a long time now, to try and
>> address Xen's almost complete absense of documentation.
>>
>> This series, plus some other in-progress conversion of the command line doc,
>> is available to view at:
>>
>>   https://andrewcoop-xen.readthedocs.io/en/latest/
>>
>> This is read-the-docs's automatic CI build of documentation from a branch on
>> gitlab.  Observe that the docs don't look like they are out of the 90's, and
>> are automatically translated into PDF and ePUB format as well.
>>
>> In due course I'll see about updating xenbits.xen.org/docs to render this as
>> well, but I don't have sufficient tuits at the moment.
>>
>> Andrew Cooper (3):
>>   docs/sphinx: Skeleton setup
>>   docs/rst: Use pandoc to render ReStructuredText
>>   docs/admin-guide: Boot time microcode loading
> I don't think these changes introduce new dependencies in the build.
> Assuming my observation is correct:
>
> Acked-by: Wei Liu <wei.liu2@citrix.com>

In the short term, no.  In due course, we'll need virtualenv and a bit
more integration for anyone wanting to build the sphinx tree locally,
but I'm fairly sure we get virtualenv automatically by already having
python as a build dependency.

~Andrew

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

  reply	other threads:[~2019-03-20 11:23 UTC|newest]

Thread overview: 16+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-03-19 16:20 [PATCH 0/3] docs: User oriented documentation Andrew Cooper
2019-03-19 16:20 ` [PATCH 1/3] docs/sphinx: Skeleton setup Andrew Cooper
2019-03-19 16:20 ` [PATCH 2/3] docs/rst: Use pandoc to render ReStructuredText Andrew Cooper
2019-03-19 16:20 ` [PATCH 3/3] docs/admin-guide: Boot time microcode loading Andrew Cooper
2019-03-19 16:40   ` Jan Beulich
2019-03-20 11:20 ` [PATCH 0/3] docs: User oriented documentation Wei Liu
2019-03-20 11:23   ` Andrew Cooper [this message]
2019-03-20 11:28     ` Wei Liu
2019-03-20 11:35       ` Andrew Cooper
2019-03-20 11:49         ` Ian Jackson
2019-03-20 12:36           ` Andrew Cooper
2019-03-20 16:43             ` Ian Jackson
2019-03-20 16:47               ` Andrew Cooper
2019-03-20 12:02         ` Wei Liu
2019-03-20 16:49           ` George Dunlap
2019-03-20 16:51             ` Andrew Cooper

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=7bd031df-b291-e9f9-3566-4fb02844eb06@citrix.com \
    --to=andrew.cooper3@citrix.com \
    --cc=George.Dunlap@eu.citrix.com \
    --cc=JBeulich@suse.com \
    --cc=ian.jackson@citrix.com \
    --cc=julien.grall@arm.com \
    --cc=konrad.wilk@oracle.com \
    --cc=lars.kurth@citrix.com \
    --cc=roger.pau@citrix.com \
    --cc=sstabellini@kernel.org \
    --cc=wei.liu2@citrix.com \
    --cc=xen-devel@lists.xen.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.