Re: [Fuego] [PATCH] Docs: Convert the Fuego wiki pages into rst docs categorized under "feature refences"

"Bird, Tim" <[email protected]> Thu, 12 Nov 2020 15:59:36 +0000
Newsgroups dev.linux.lists.fuego
Message-ID <BY5PR13MB2933129ABF655739C734A58FFDE70@BY5PR13MB2933.namprd13.prod.outlook.com>
> -----Original Message-----
> From: Pooja Sanjay More <[email protected]>
> 
> Hi Tim,
> 
> Regarding label anchors,  yes we have to change the cross referencing conventions in all the previously  added  files if we
> use the "autosectionlabel_prefix_document" method.  So shall I send the next patch with previous conventions ?

Yes.  Let's not use the autosectionlabel_prefix_document option.

Instead, in the rare cases that the section names conflict, let's make up alternative (unique) section
labels, and reference those.

Can you please do that for the reference in Test_Specs_and_Plans.rst?


Do you know what Sphinx does with the duplicate automatic section names?  Do we get an error during build?
Eventually, when all the pages have been transferred, and outstanding links fixed, I would like to work on
fixing the errors and warnings from the documentation build.  It would be nice to get the errors and warnings
eliminated so that it will be easier to catch new problems as they are introduced in the documentation in the
future.

In any event, it might be worth changing the section names to come up with names that is unique.
(However, it might also be a pain to have to require all section names to be globally unique, especially as
more tutorial pages are created.  We'll see what problems we run into as we finish the document
conversion.)

 -- Tim


> 
> 
> Thanks and regards,
> Pooja More
>