cusignal icon indicating copy to clipboard operation
cusignal copied to clipboard

Ensure no warnings in documentation builds

Open AyodeAwe opened this issue 2 years ago • 1 comments

Is your feature request related to a problem? Please describe. Currently, the cusignal documentation does not build without some issues. These issues show up as warnings in the documentation build logs. An example is here:

/opt/conda/envs/docs/lib/python3.9/site-packages/cusignal/filtering/resample.py:docstring of cusignal.filtering.resample.decimate:6: ERROR: Unexpected indentation.
/opt/conda/envs/docs/lib/python3.9/site-packages/cusignal/filtering/resample.py:docstring of cusignal.filtering.resample:3: WARNING: Block quote ends without a blank line; unexpected unindent.

This was discovered when attempting to run the sphinx-build command with the -W flag. The -W flag causes the build to fail in the event of warnings by turning warnings to errors. (See here)

Describe the solution you'd like The ideal scenario is to have the cusignal documentation build successfully without warnings. The addition of the -W flag to the sphinx build command would ensure this.

Describe alternatives you've considered We currently run the build command without the -W flag, ignoring any warnings that get outputted.

Additional context About 137 warnings are emitted at the time of writing this. See this example run.

AyodeAwe avatar Feb 10 '23 14:02 AyodeAwe

For reference, the PR where is issue was discovered is below.

  • https://github.com/rapidsai/cusignal/pull/536

ajschmidt8 avatar Feb 14 '23 18:02 ajschmidt8