Re: [PATCH] libqos/qgraph: format qgraph comments for sphinx documentation

[Emanuele Giuseppe Esposito]

On 25/02/2021 11:05, Paolo Bonzini wrote:
> On 25/02/21 09:22, Emanuele Giuseppe Esposito wrote:
> > diff --git a/docs/devel/index.rst b/docs/devel/index.rst
> > index 1dcce3bbed..f0038f8722 100644
> > --- a/docs/devel/index.rst
> > +++ b/docs/devel/index.rst
> > @@ -12,6 +12,7 @@ Contents:
> >
> >   .. toctree::
> >      :maxdepth: 2
> > +   :includehidden:
> >
> >      build-system
> >      kconfig
> > @@ -24,7 +25,6 @@ Contents:
> >      atomics
> >      stable-process
> >      qtest
> > -   qgraph
> >      decodetree
> >      secure-coding-practices
> >      tcg
> >
> > -------
> >
> > Allow showing the hidden toctree in the docs/devel index, so that the 
> > link is visible
> >
> > End result:
> > - no visible change in docs/index
> > - qgraph link visible in docs/devel/index
> > - qgraph linked as text link in qtree
>
> Makes sense.  Did you also try increasing the maxdepth?

Yes, it does not change much on the qgraph side. By default, with this 
depth a simple toctree with qgraph would be already visible in both indexes.

As I see it, qgraph is a "subsection" of qtest, not a separate entry in 
docs/index, that is why I am hiding it.

I will go ahead and submit the patch for the sphinx documentation.
As you suggested, better qraph examples and explanations will follow in 
a separate serie.

Thank you,
Emanuele