[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [PATCH v6 18/18] docs: add Orange Pi PC document

From: Niek Linnenbank
Subject: Re: [PATCH v6 18/18] docs: add Orange Pi PC document
Date: Mon, 9 Mar 2020 21:47:46 +0100

On Mon, Mar 9, 2020 at 9:12 PM Peter Maydell <address@hidden> wrote:
On Mon, 9 Mar 2020 at 20:05, Niek Linnenbank <address@hidden> wrote:
> Ah now I see what is going on here. So the new rst files are ment to automatically generate
> documentation in various formats using the Python sphinx tool, correct?

Yep. Assuming you have Sphinx installed, "make" should build the
documentation as well as the executables (ie you don't need
specifically 'make html').

> I played around a bit with running 'make html' and using the include directive you suggested in
> the target-arm.rst file like:
>   .. include:: orangepi.rst

I'm currently writing a patchset which splits the existing
target-arm.rst into a bunch of per-board files in
docs/system/arm/. If that patchset goes in before you
roll the next verison of the series then it should
just be a matter of putting orangepi.rst in the
docs/system/arm/ directory and adding a line to the
table-of-contents in docs/system/target-arm.rst.

Ah yes, that makes sense indeed. I'll keep an eye out for your new patchset.
If you're ready to send out the next version before that,
then leave it with the include:: directive and we can
fix it up to the new structure later.

OK Peter!

-- PMM

Niek Linnenbank

reply via email to

[Prev in Thread] Current Thread [Next in Thread]