Skip to content

Commit

Permalink
Remove TestOne and TestTwo from Docs. Add missing data_structure arg
Browse files Browse the repository at this point in the history
allow TOC to show each filter in the side bar.

Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
imikejackson committed Sep 17, 2023
1 parent c4012f9 commit 9ab3722
Showing 1 changed file with 8 additions and 0 deletions.
8 changes: 8 additions & 0 deletions wrapping/python/docs/generate_sphinx_docs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -353,6 +353,9 @@ void GenerateRstFilterDocs()
IFilter::UniquePointer filter = filterListPtr->createFilter(filterHandle);
// auto plugin = filterListPtr->getPlugin(filterHandle);

rstStream << filterClassName << "\n";
rstStream << GenerateUnderline(filterClassName.size(), '-') << "\n\n";

rstStream << ".. _" << filterClassName << ":\n";
rstStream << ".. py:class:: " << filterClassName << "\n\n";

Expand Down Expand Up @@ -402,6 +405,7 @@ void GenerateRstFilterDocs()
rstStream << " .. py:method:: Execute(data_structure";

std::stringstream memberStream;
memberStream << " :param complex.DataStructure data_structure: The DataStructure object that holds the data to be processed.\n";

size_t index = 0;
for(const auto& parameterPair : parameters)
Expand Down Expand Up @@ -463,6 +467,10 @@ void GenerateIndexRstFile()
for(const auto& plugin : pluginListPtr)
{
std::string plugName = plugin->getName();
if(plugName == "TestOne" || plugName == "TestTwo")
{
continue;
}
const std::string pluginRootDir = fmt::format("{}", s_PluginDirMap[plugName]);

if(plugName == "ComplexCore")
Expand Down

0 comments on commit 9ab3722

Please sign in to comment.