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

[Niek Linnenbank <nieklinnenbank@gmail.com>]

[-- Attachment #1: Type: text/plain, Size: 1859 bytes --]

On Mon, Mar 9, 2020 at 8:43 PM Peter Maydell <peter.maydell@linaro.org>
wrote:

> On Mon, 9 Mar 2020 at 19:38, Niek Linnenbank <nieklinnenbank@gmail.com>
> wrote:
> > On Mon, Mar 9, 2020 at 12:22 PM Peter Maydell <peter.maydell@linaro.org>
> wrote:
> >> Yes, this is now the right place to put arm board-specific
> >> documentation (the rearranging and conversion from texinfo
> >> is now in master). I should move microvm.rst's contents there
> >> I guess.
> >
> >
> > OK, I'll move orangepi.rst to docs/system/orangepi.rst and add a short
> section
> > about the Orange Pi PC machine to docs/system/target-arm.rst as well.
>
> You should include/reference the orangepi.rst from target-arm.rst, I think
> --
> that's where the per-board docs would belong in the structure we have.
> If you just drop a .rst file into the docs directory somewhere it won't
> actually go into the documentation and instead Sphinx will error
> out about it not being in the table of contents anywhere.
>

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?
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

That seems to work. And, now I also see that the orangepi.rst file contains
rst syntax errors which
I need to resolve. I'll make sure those are resolved in the next version.


>
> (I'll have a look at microvm.rst to see how best to make the structure
> work -- at the moment it kind of assumes there board documentation
> is always quite short so they're all in one file.)
>

Yeah that is fine Peter. If you have any update on that later, I'll adjust
the orangepi.rst file to fit in as well.

Regards,
Niek


>
> thanks
> -- PMM
>


-- 
Niek Linnenbank

[-- Attachment #2: Type: text/html, Size: 3017 bytes --]