def GetNavYml()

in DocBuild.py [0:0]


    def GetNavYml(self, string, prefix):
        if self.Leaf is not None:
            return string + ' "' + self.Leaf + '"'
        string2 = ""

        # Dev Note: it was decided that a "Docs" folder found at the root of a Edk2 Package
        #           should be treated special and put first in the TOC within the Package.  It also
        #           should be renamed to something more descriptive than docs
        #
        if(NavTree.SPECIAL_KEY_FIND_PKG_DOCS in self.Children.keys()):
            string1 = "\n" + prefix + "- " + self.MakeFriendly(NavTree.SPECIAL_KEY_REPLACE_WITH) + ":"
            string2 += self.Children[NavTree.SPECIAL_KEY_FIND_PKG_DOCS].GetNavYml(string1, prefix + "  ")

        for (name, cnode) in self.Children.items():
            if name == NavTree.SPECIAL_KEY_FIND_PKG_DOCS:
                # already inserted above
                continue
            string1 = "\n" + prefix + "- " + self.MakeFriendly(name) + ":"
            string2 += cnode.GetNavYml(string1, prefix + "  ")
        return string + string2