Skip to content

Commit

Permalink
BUG: Broken external links for the SimplnxCore filters within the pyt…
Browse files Browse the repository at this point in the history
…hon docs

Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
imikejackson committed Nov 22, 2024
1 parent ace11c0 commit 41ee443
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion wrapping/python/docs/generate_sphinx_docs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -640,6 +640,7 @@ void GeneratePythonRstFiles()
for(const auto& plugin : pluginListPtr)
{
std::string plugName = plugin->getName();
std::string fullPluginName = plugName;
const std::string pluginRootDir = fmt::format("{}", s_PluginDirMap[plugName]);
if(pluginRootDir.empty())
{
Expand Down Expand Up @@ -711,7 +712,7 @@ void GeneratePythonRstFiles()
rstStream << " " << rstDescription << "\n\n";

// Tack on the link to the web address for the full documentation
const std::string webAddress = fmt::format("{}/{}/{}/{}.html", k_WebServerAddress, k_WebServerFilterFolder, plugName, filterClassName);
const std::string webAddress = fmt::format("{}/{}/{}/{}.html", k_WebServerAddress, k_WebServerFilterFolder, fullPluginName, filterClassName);
rstStream << " `Link to the full online documentation for " << filterClassName << " <" << webAddress << ">`_ \n\n";

const auto& parameters = filter->parameters();
Expand Down

0 comments on commit 41ee443

Please sign in to comment.