Add a new style of generated documentation

src/axom/inlet/SphinxWriter.cpp

@@ -58,19 +58,29 @@ constexpr typename std::underlying_type<E>::type to_underlying(const E e)
 
 }  // namespace detail
 
-SphinxWriter::SphinxWriter(const std::string& fileName)
+SphinxWriter::SphinxWriter(const std::string& fileName,
+                           const std::string& title,
+                           const Style style)
   : m_fieldColLabels({"Field Name",
                       "Description",
                       "Default Value",
                       "Range/Valid Values",
                       "Required"})
   , m_functionColLabels(
       {"Function Name", "Description", "Signature", "Required"})
+  , m_style(style)
 {
   m_fileName = fileName;
   m_oss << ".. |uncheck|    unicode:: U+2610 .. UNCHECKED BOX\n";
   m_oss << ".. |check|      unicode:: U+2611 .. CHECKED BOX\n\n";
-  writeTitle("Input file Options");
+  if(title.empty())
+  {
+    writeTitle("Input file Options");
+  }
+  else
+  {
+    writeTitle(title);
+  }
 }
 
 void SphinxWriter::documentContainer(const Container& container)
@@ -114,6 +124,16 @@ void SphinxWriter::documentContainer(const Container& container)
     currContainer.description = sidreGroup->getView("description")->getString();
   }
 
+  // Bail out if this is a collection of primitives -
+  // it doesn't make sense to document each individual primitive
+  // FIXME: Implement something analogous to the logic for struct collections that displays the
+  // "schema" for the primitive elements of the collection
+  if(isCollectionGroup(container.name()) &&
+     !sidreGroup->hasView(detail::STRUCT_COLLECTION_FLAG))
+  {
+    return;
+  }
+
   for(const auto& field_entry : container.getChildFields())
   {
     extractFieldMetadata(field_entry.second->sidreGroup(), currContainer);
@@ -123,11 +143,47 @@ void SphinxWriter::documentContainer(const Container& container)
   {
     extractFunctionMetadata(function_entry.second->sidreGroup(), currContainer);
   }
+
+  // If it's not a collection,  we need to record the child containers
+  if(!isCollectionGroup(container.name()))
+  {
+    for(const auto& container_entry : container.getChildContainers())
+    {
+      if(!isCollectionGroup(container_entry.first))
+      {
+        const auto name = removeBeforeDelimiter(container_entry.first);
+        std::string description;
+        const auto group = container_entry.second->sidreGroup();
+        const static auto collectionDescriptionPath =
+          appendPrefix(detail::COLLECTION_GROUP_NAME, "description");
+        if(group->hasView("description"))
+        {
+          description = group->getView("description")->getString();
+        }
+        else if(group->hasView(collectionDescriptionPath))
+        {
+          // If the label is applied to the collection group itself, we can use that instead
+          description = group->getView(collectionDescriptionPath)->getString();
+        }
+        currContainer.childContainers.push_back(
+          {std::move(name),
+           std::move(description),
+           detail::isTrivial(*container_entry.second)});
+      }
+    }
+  }
 }
 
 void SphinxWriter::finalize()
 {
-  writeAllTables();
+  if(m_style == Style::Nested)
+  {
+    writeNestedTables();
+  }
+  else
+  {
+    writeAllTables();
+  }
   m_outFile.open(m_fileName);
   m_outFile << m_oss.str();
   m_outFile.close();
@@ -213,6 +269,130 @@ void SphinxWriter::writeAllTables()
   }
 }
 
+void SphinxWriter::writeNestedTables()
+{
+  // Used to avoid duplicate hyperlinks
+  int containerCount = 0;
+  for(const auto& pathName : m_inletContainerPathNames)
+  {
+    const auto& currContainer = m_rstTables.at(pathName);
+
+    if(!currContainer.isSelectedElement)
+    {
+      writeSubtitle(currContainer.containerName);
+    }
+
+    if(currContainer.description != "")
+    {
+      m_oss << currContainer.description << "\n\n";
+    }
+
+    const auto& fields = currContainer.fieldTable;
+    const auto& functions = currContainer.functionTable;
+    const auto& containers =
+      currContainer.childContainers;  // Contains only names and descriptions
+
+    if(fields.size() > 1 || functions.size() > 1 || !containers.empty())
+    {
+      m_oss << ".. list-table::\n";
+      m_oss << "   :widths: 25 50\n";
+      m_oss << "   :header-rows: 1\n";
+      m_oss << "   :stub-columns: 1\n\n";
+      m_oss << "   * - Name\n";
+      m_oss << "     - Description\n";
+    }
+
+    // Writes a name + description to the "table of contents"
+    // for each Container
+    auto writeTOCEntry = [this,
+                          containerCount](const std::vector<std::string>& data) {
+      // FIXME: Overlapping link names? Need to use the full path or a hash??
+      m_oss << fmt::format("   * - :ref:`{0}<{0}{1}>`\n", data[0], containerCount);
+      m_oss << fmt::format("     - {0}\n", data[1]);
+    };
+
+    // FIXME: Would it be useful to alphabetize these??
+    for(const auto& container : containers)
+    {
+      // We can set up a hyperlink to non-trivial tables because they will
+      // be subsequently documented
+      if(container.isTrivial)
+      {
+        m_oss << fmt::format("   * - {0}\n", container.name);
+      }
+      else
+      {
+        m_oss << fmt::format("   * - `{0}`_\n", container.name);
+      }
+      m_oss << fmt::format("     - {0}\n", container.description);
+    }
+
+    // Need to skip first element (header row), hence no range-based for loop
+    std::for_each(fields.begin() + 1, fields.end(), writeTOCEntry);
+    std::for_each(functions.begin() + 1, functions.end(), writeTOCEntry);
+
+    m_oss << "\n\n";
+
+    // Now, dump the full descriptions
+    std::for_each(
+      fields.begin() + 1,
+      fields.end(),
+      [this, containerCount](const std::vector<std::string>& fieldData) {
+        // Insert a hyperlink target for the name
+        m_oss << fmt::format(".. _{0}{1}:\n\n", fieldData[0], containerCount);
+        m_oss << fmt::format("**{0}**\n\n", fieldData[0]);  // name
+        // description - ideally this would be an extended description
+        m_oss << fieldData[1] << "\n\n";
+
+        // The default value
+        if(!fieldData[2].empty())
+        {
+          m_oss << fmt::format("  - Default value: {0}\n", fieldData[2]);
+        }
+
+        // The valid values
+        if(!fieldData[3].empty())
+        {
+          m_oss << fmt::format("  - Valid values: {0}\n", fieldData[3]);
+        }
+
+        // Whether it's required
+        if(!fieldData[4].empty())
+        {
+          const bool isRequired = fieldData[3] == "|check|";
+          m_oss << fmt::format("  - {0}\n", isRequired ? "Required" : "Optional");
+        }
+        m_oss << "\n\n";
+      });
+
+    std::for_each(
+      functions.begin() + 1,
+      functions.end(),
+      [this, containerCount](const std::vector<std::string>& functionData) {
+        // Insert a hyperlink target for the name
+        m_oss << fmt::format(".. _{0}{1}:\n\n", functionData[0], containerCount);
+        m_oss << fmt::format("**{0}**\n\n", functionData[0]);  // name
+        // description - ideally this would be an extended description
+        m_oss << functionData[1] << "\n\n";
+
+        // The function's signature
+        if(!functionData[2].empty())
+        {
+          m_oss << fmt::format("  - Signature: {0}\n", functionData[2]);
+        }
+
+        // Whether it's required
+        if(!functionData[3].empty())
+        {
+          const bool isRequired = functionData[3] == "|check|";
+          m_oss << fmt::format("  - {0}\n", isRequired ? "Required" : "Optional");
+        }
+        m_oss << "\n\n";
+      });
+    containerCount++;
+  }
+}
+
 std::string SphinxWriter::getValueAsString(const axom::sidre::View* view)
 {
   axom::sidre::TypeID type = view->getTypeID();

src/axom/inlet/SphinxWriter.hpp

@@ -39,14 +39,29 @@ namespace inlet
 class SphinxWriter : public Writer
 {
 public:
+  /*!
+  *******************************************************************************
+  * \brief Supported Sphinx style options
+  *******************************************************************************
+  */
+  enum class Style
+  {
+    Flat,   // Tables for the child Fields/Functions of each Container
+    Nested  // Table of contents for each Container, then sections for each child
+  };
+
   /*!
   *******************************************************************************
   * \brief A constructor for SphinxWriter.
   * 
   * \param [in] fileName The name of the file the documentation should be written to.
+  * \param [in] title The title of the generated rst file
+  * \param [in] style The style of docs to generate
   *******************************************************************************
   */
-  SphinxWriter(const std::string& fileName);
+  SphinxWriter(const std::string& fileName,
+               const std::string& title = {},
+               const Style style = Style::Flat);
 
   void documentContainer(const Container& container) override;
 
@@ -107,6 +122,8 @@ class SphinxWriter : public Writer
    */
   void writeAllTables();
 
+  void writeNestedTables();
+
   /*!
   *******************************************************************************
   * \struct ContainerData
@@ -143,6 +160,21 @@ class SphinxWriter : public Writer
     bool isSelectedElement;
     std::vector<std::vector<std::string>> fieldTable;
     std::vector<std::vector<std::string>> functionTable;
+    /**
+     * \brief Stores a minimal set of data about child containers
+     * Used only for the table of contents in nested "mode"
+     */
+    struct ChildContainerData
+    {
+      std::string name;
+      std::string description;
+      /**
+       * \brief Whether the container contains any fields/functions in any of its subcontainers
+       * \see detail::isTrivial
+       */
+      bool isTrivial;
+    };
+    std::vector<ChildContainerData> childContainers;
   };
 
   /*!
@@ -249,6 +281,7 @@ class SphinxWriter : public Writer
   std::vector<std::string> m_fieldColLabels;
   // Used for the RST tables for functions
   std::vector<std::string> m_functionColLabels;
+  Style m_style;
 };
 
 }  // namespace inlet

src/axom/inlet/docs/sphinx/advanced_types.rst

@@ -1,3 +1,8 @@
+.. ## Copyright (c) 2017-2021, Lawrence Livermore National Security, LLC and
+.. ## other Axom Project Developers. See the top-level COPYRIGHT file for details.
+.. ##
+.. ## SPDX-License-Identifier: (BSD-3-Clause)
+
 .. _inlet_advanced_types_label:
 
 ##############

src/axom/inlet/docs/sphinx/example1_expected_documentation.rst → src/axom/inlet/docs/sphinx/example1_flat_documentation.rst

@@ -1,9 +1,9 @@
 .. |uncheck|    unicode:: U+2610 .. UNCHECKED BOX
 .. |check|      unicode:: U+2611 .. CHECKED BOX
 
-==================
-Example Output: Input File Options
-==================
+===============================================
+Example Output: Input File Options (flat mode)
+===============================================
 
 --------------
 thermal_solver