Skip to content

Commit

Permalink
DOC: adjust how we generate the Sphinx .rst files
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Jackson <[email protected]>
  • Loading branch information
imikejackson committed Apr 15, 2024
1 parent a0d8cce commit 809f1c1
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions wrapping/python/docs/generate_sphinx_docs.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -730,13 +730,13 @@ void GeneratePythonRstFiles()
IFilter::UniquePointer filter = filterListPtr->createFilter(filterHandle);
// auto plugin = filterListPtr->getPlugin(filterHandle);

rstStream << filterClassName << "\n";
rstStream << GenerateUnderline(filterClassName.size(), '-') << "\n\n";
rstStream << filter->humanName() << "\n";
rstStream << GenerateUnderline(filter->humanName().size(), '-') << "\n\n";
rstStream << ".. index:: pair: Filter Human Names; " << filter->humanName() << "\n";
rstStream << ".. index:: pair: Filter Class Names; " << filter->className() << "\n";

rstStream << "\n";
rstStream << "- **UI Name**: " << filter->humanName() << "\n\n";
//rstStream << "- **UI Name**: " << filter->humanName() << "\n\n";

Check failure on line 739 in wrapping/python/docs/generate_sphinx_docs.cpp

View workflow job for this annotation

GitHub Actions / clang_format_pr

code should be clang-formatted [-Wclang-format-violations]

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

Expand Down

0 comments on commit 809f1c1

Please sign in to comment.