Build pdoc #529
Merged
Build pdoc #529
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
AlexanderRichert-NOAA
force-pushed
the
pdoc_fix
branch
from
7900674
to
18134b4
Compare
|
This looks great Alex - thanks!! |
jbathegit
approved these changes
Oct 10, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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