Re: Documents not in sphinx toctree

[Peter Maydell]

On Thu, 5 Nov 2020 at 16:14, Marc-André Lureau
<marcandre.lureau@gmail.com> wrote:
> By running sphinx over the docs/ directory (like readthedocs.org presumably 
> does), it finds a couple of rst documents that are not referenced:
> - cpu-hotplug.rst
> - microvm.rst
> - pr-manager.rst
> - virtio-net-failover.rst
> - virtio-pmem.rst
>
> Shouldn't they be?

These all need to be moved into the correct manual. That
might involve splitting them into several pieces so that
the different pieces can go into different manuals.

The difficulty is that this requires attention from somebody
who has at least some vague idea of the contents and who
can move them around appropriately.

In the meantime, they're in exactly the same boat as
the various *.txt documents in docs/ -- old stuff
that doesn't end up in the user-facing manuals and which
nobody's got round to properly integrating into the docs yet.

> If not (I wonder why), there should be a way to explicitly
> exclude those, and avoid extra warnings.

The only thing that runs sphinx directly on the docs
is readthedocs, and it doesn't care about warnings :-)

thanks
-- PMM