'Sphinx suppress specific warnings?
In building my documentation I'm running into a lot of warning messages such as the following:
/home/X/Y/src/core/include/math/bigintntl/transformntl.h:92: warning: documented empty return type of NTL::NumberTheoreticTransformNtl::ForwardTransformToBitReverseInPlace.
I'd like to turn off the specific warnings related to X is not documented. How might I go about doing so? I'm building the documentation of a rather large library, and until we have time to go back and update the docs, this just adds a lot of noise to our builds.
The documenting line:
/**
* In-place forward transform in the ring Z_q[X]/(X^n+1) with prime q and
* power-of-two n s.t. 2n|q-1. Bit reversing indexes. [Algorithm 1 in
* https://eprint.iacr.org/2016/504.pdf]
*
* @param &rootOfUnityTable is the table with the n-th root of unity powers in
* bit reverse order.
* @param &element[in,out] is the input/output of the transform of type VecType and length n.
* @return none
*/
void ForwardTransformToBitReverseInPlace(
const VecType& rootOfUnityTable, VecType* element);
from OpenFHE library
and the .rst
file looks like the following (autodoxygenindex
is a Breathe directive: https://breathe.readthedocs.io/en/latest/directives.html#autodoxygenindex):
Core Math Big Int NTL Documentation
=========================================
.. autodoxygenindex::
:project: core_math_bigintntl
while the conf.py
file is here.
Solution 1:[1]
Looks like the issue for me was that breathe
was regenerating the documentation because I was using a specific command. Unfortunately, this regeneration seemed to ignore the Doxyfile
that was coming in. So, I had to manually pass in the relevant variables via breathe_doxygen_config_options
See breathe config-values
Sources
This article follows the attribution requirements of Stack Overflow and is licensed under CC BY-SA 3.0.
Source: Stack Overflow
Solution | Source |
---|---|
Solution 1 | user18031872 |