class_docstr: Main documentation class
class_docstr_tok: ["Main","documentation","class"]
docstr: Generates a referenced index for markdown file
code: def gen_overview(self):
      """Generates a referenced index for markdown file"""
      md = MarkdownFile()
      md.title(3, "Overview")
      for module_name in sorted(self.master_dict):
          module = self.master_dict[module_name]
          module_key = "#" + module_name
          md.list_pushn(
              brackets(bold(module_key[1:]))
              + parentheses(module_key)
              + " "
              + sub(italic("Module"))
          )
          # Generate class overview (if any)
          if "classes" in module and module["classes"]:
              for cl in sorted(module["classes"]):
                  class_name = cl["class_name"]
                  class_key = join([module_key, class_name], ".")
                  md.list_pushn(
                      join(
                          [
                              brackets(bold(class_name)),
                              parentheses(class_key),
                              " ",
                              sub(italic("Class")),
                          ]
                      )
                  )
                  # Generate class instance variables overview (if any)
                  if (
                      "instance_variables" in cl
                      and cl["instance_variables"]
                  ):
                      for inst_var in cl["instance_variables"]:
                          md.list_push(
                              gen_inst_var_indx(inst_var, class_key)
                          )
                          md.list_popn()
                  # Generate class methods overview (if any)
                  if "methods" in cl and cl["methods"]:
                      for method in sorted(
                          cl["methods"], key=lambda i: i["def_name"]
                      ):
                          md.list_push(
                              gen_method_indx(method, class_key)
                          )
                          md.list_popn()
                  md.list_pop()
          md.list_pop()
      return md.data()
  
imports: import os
  import yaml
  import re
  import doc_gen_snipets
label_desc: Use image node_id 2 for calling the Documentation obj's underlying member method code with example usage: obj.gen_overview() and returns: md