search

NOAA-EMC / NCEPLIBS-bufr

The NCEPLIBS-bufr library contains routines and utilites for working with the WMO BUFR format.
Other
42 stars 19 forks source link

Build pdoc #529

Closed AlexanderRichert-NOAA closed 9 months ago

AlexanderRichert-NOAA commented 9 months ago

This PR enables python documentation through pdoc in the developer CI. It gets placed under the rest of the docs directory structure so it's in the same output artifact.

One caveat is that I've put the doc build in a separate CI step from the rest of the testing. This is because the use of the memory sanitizer and gcov don't play nicely with python. pdoc, for whatever reason, needs to load the python module, but when asan and gcov are enabled they put a bunch of special functions in the bufr library, so the python module load fails with "undefined reference" errors. I think the easiest solution is to put them in separate steps (as opposed to trying to hack together some LD_PRELOAD magic).

Fixes #230

jbathegit commented 9 months ago

This looks great Alex - thanks!!