Fix documentation builds #1039

dagardner-nv · 2023-07-11T22:40:41Z

Description

Remove documentation-only deps from docker/conda/environments/cuda11.8_dev.yml
morpeus_docs cmake target removed from default build target
documentation deps are now installed from conda-forge not pypi
Set an env variable MORPHEUS_IN_SPHINX_BUILD during documentation builds allowing the code to bypass certain calls with side-effects.
Sphinx now treats all warnings as fatal errors.
Removed out of date docs/source/control_message_guide.md doc
Fix numerous docstring issues & broken links
Private symbols moved into anonymous namespaces to prevent them from being visible to doxygen.
CudfHelper::load() avoids calling import_morpheus___lib__cudf_helpers if MORPHEUS_IN_SPHINX_BUILD is defined.
morpheus/utils/nvt/mutate.py will now defined a stub annotate decorator if MORPHEUS_IN_SPHINX_BUILD is defined.
morpheus/utils/schema_transforms.py will avoid calling patch_numpy_dtype_registry and register_morpheus_extensions if MORPHEUS_IN_SPHINX_BUILD is defined.
Replace empty __alll__ declarations in __init__.py files

fixes #1028

Checklist

I am familiar with the Contributing Guidelines.
New or existing tests cover these changes.
The documentation is up to date with these changes.

This reverts commit 71e9950.

This reverts commit c29f834.

…o avoid loading cudf_helpers Treat all warnings as errors Add dependencies on the rest of the build

…rforming a documentation build

…in favor of docs/source/developer_guide/guides/9_control_messages.md

…ate to morpheus

…rol over this until we can adopt Sphinx 5

…warnings-1028

…eate

…ine a solution for this

…warnings-1028

…ions during Sphinx builds

…e a simple pass-thru decorator for sphinx builds

…ur mocked annotate decorator from documentation [no ci]

…udf_helpers.pyx as pylint doesn't understand cython, fix dfencoder exclude

…le duplication

mdemoret-nv

Looks much better now. Would like to see the DFP modules added into the API, but I'll add a new issue for that later

dagardner-nv · 2023-07-13T00:53:20Z

/merge

dagardner-nv added 11 commits July 11, 2023 10:41

Resolve unbalanced group warning

890bbbb

Don't throw an error when we're in a sphinx build

71e9950

Revert "Don't throw an error when we're in a sphinx build"

4dd86b3

This reverts commit 71e9950.

wip

faeaee7

Update to the latest vers avail

c29f834

Move read_idx_from_tensor to an anon namespace to hide it from doxygen

71b5f2e

Fix unintentional \n in docstring

ffc4353

Revert "Update to the latest vers avail"

5b801a4

This reverts commit c29f834.

Set an MORPHEUS_IN_SPHINX_BUILD env variable allowing cudf_util.cpp t…

ddbbe66

…o avoid loading cudf_helpers Treat all warnings as errors Add dependencies on the rest of the build

Don't attempt to call import_morpheus___lib__cudf_helpers if we're pe…

7f1a713

…rforming a documentation build

Ignore doca code, ignore torch

287024b

dagardner-nv requested a review from a team as a code owner July 11, 2023 22:40

dagardner-nv and others added 9 commits July 11, 2023 15:41

revert

e6a148f

Devin informed me this doc was out of date and shouldn't be included …

b550805

…in favor of docs/source/developer_guide/guides/9_control_messages.md

Remove --keep-going

f93f89b

wip

12380b7

Move private impl structs to an anon namespace to hide them from doxygen

4d21698

Misc sphinx fixes

5d3d8b6

Link to orphaned docs [no ci]

7c5d87c

wip [no ci]

4d72f5d

Cleaning up the docs a bit

55b9d1e

mdemoret-nv requested a review from a team as a code owner July 12, 2023 03:32

dagardner-nv and others added 8 commits July 11, 2023 21:02

Add comment explaining the env variable check

261e932

Fix long line

d3472b4

Add dfp to the python path allowing linking to dfp code from docs

545cbb3

Exclude the CHECK_KAFKA macro from doxygen, this macro should be priv…

99f9840

…ate to morpheus

WIP [no ci]

3ec24ae

Merge branch 'branch-23.07' into david-doc-build-warnings-1028

cde15a8

Silence deprecation warnings coming from docutils, we don't have cont…

89422d3

…rol over this until we can adopt Sphinx 5

Fix broken links

0c6a6c8

dagardner-nv added 5 commits July 12, 2023 08:43

Merge branch 'david-doc-build-warnings-1028-p2' into david-doc-build-…

2da79bd

…warnings-1028

Remove links to non-existent documents that we haven't had time to cr…

cf3dcd3

…eate

WIP: For now remove links to file outside of docs/source TODO: determ…

ed0e7fa

…ine a solution for this

Remove json from code blocks that cannot parse as valid json

104fc7a

Merge branch 'david-doc-build-warnings-1028-p2' into david-doc-build-…

d72f9b0

…warnings-1028

jarmak-nv assigned dagardner-nv Jul 12, 2023

dagardner-nv added 5 commits July 12, 2023 11:26

Avoid calling patch_numpy_dtype_registry and register_morpheus_extens…

a46518a

…ions during Sphinx builds

Sphinx builds fail when the annotate decorator is used, instead defin…

a5818fb

…e a simple pass-thru decorator for sphinx builds

sys.path improvements from MDD, mock merlin, nvtabular, and exclude o…

22bff4d

…ur mocked annotate decorator from documentation [no ci]

Ignore sphinx's conf.py and github_link.py from pylint, also ignore c…

4fe882b

…udf_helpers.pyx as pylint doesn't understand cython, fix dfencoder exclude

Pylint fixes and ignores

2410f8c

dagardner-nv changed the title ~~WIP: documentation builds~~ Fix documentation builds Jul 12, 2023

dagardner-nv added non-breaking Non-breaking change doc Improvements or additions to documentation 2 - In Progress labels Jul 12, 2023

Update doc on building docs

c7eb676

dagardner-nv added 3 - Ready for Review and removed 2 - In Progress labels Jul 12, 2023

Replace empty __all__'s

0568e5a

drobison00 approved these changes Jul 12, 2023

View reviewed changes

Adding the modules section to the toctree using markdown to remove fi…

1da989f

…le duplication

mdemoret-nv approved these changes Jul 12, 2023

View reviewed changes

dagardner-nv added 3 commits July 12, 2023 15:42

IWYU fixes

c70cff6

Delete orphaned indexes

d6a8c08

Disable python stubs

103a6a0

rapids-bot bot merged commit e7911f3 into nv-morpheus:branch-23.07 Jul 13, 2023
4 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix documentation builds #1039

Fix documentation builds #1039

dagardner-nv commented Jul 11, 2023 •

edited

Loading

mdemoret-nv left a comment

dagardner-nv commented Jul 13, 2023

Fix documentation builds #1039

Fix documentation builds #1039

Conversation

dagardner-nv commented Jul 11, 2023 • edited Loading

Description

Checklist

mdemoret-nv left a comment

Choose a reason for hiding this comment

dagardner-nv commented Jul 13, 2023

dagardner-nv commented Jul 11, 2023 •

edited

Loading