Open Stack

On Mon, 2019-06-24 at 16:36 -0700, Michael Johnson wrote:
> 4. We should document how to ignore or re-order the docs. We have an
> internal API reference that comes through as the first section, but is
> of little use to anyone outside the developers. It is also confusing
> as the actual Octavia API-REF link doesn't render.

I think this happens because it renders pages in the order that it
encounters them. If you ensure there's a table of contents on the index
page of each subsection ('/user', '/admin', '/config', ...), and that
there's a top-level table of contents linking to each of these from
your 'master_doc' as defined in 'conf.py (typically 'index') then
things _should_ render in the correct order. These table of contents
_could_ be hidden, though I haven't tested that yet.

I plan to rework the nova docs according to the above...as soon as I
get the darn thing building.

Stephen