Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[BUG]: Fix issues with Documentation CI stage #1028

Closed
2 tasks done
mdemoret-nv opened this issue Jul 10, 2023 · 1 comment · Fixed by #1039
Closed
2 tasks done

[BUG]: Fix issues with Documentation CI stage #1028

mdemoret-nv opened this issue Jul 10, 2023 · 1 comment · Fixed by #1039
Assignees
@dagardner-nv
Labels
bug Something isn't working

Comments

@mdemoret-nv
Copy link
Contributor

Version

23.07

Which installation method(s) does this occur on?

Source

Describe the bug.

Lately, the Documentation stage from CI has been generating a lot of error/warning messages that need to be cleaned up prior to release. An example of this is shown here from a recent CI run.

To complete this issue, the following should be performed:

  1. Determine if the messages shown in CI are errors
    1. If they are errors, why did the CI stage not fail?
    2. Update the documentation CI scripts to properly fail when errors are generated
  2. Improve the docstrings to produce no error messages and minimize the number of warning messages
    1. Ideally, we would have no error or warning messages generated during the documentation step.

Minimum reproducible example

No response

Relevant log output

No response

Full env printout

No response

Other/Misc.

No response

Code of Conduct

  • I agree to follow Morpheus' Code of Conduct
  • I have searched the open bugs and have found no duplicates for this bug report
@mdemoret-nv mdemoret-nv added the bug Something isn't working label Jul 10, 2023
@dagardner-nv
Copy link
Contributor

dagardner-nv commented Jul 11, 2023 •
edited
Loading

If they are errors, why did the CI stage not fail?

I can reproduce these locally, they all appear to be errors at Sphinx attempts to auto-doc parts of our code, these are caught/logged by Sphinx and the build exits with an exit-code of 0.

Correction, several Python modules are failing to generate API docs.

@dagardner-nv dagardner-nv mentioned this issue Jul 12, 2023
Merged
3 tasks
rapids-bot bot pushed a commit that referenced this issue Jul 13, 2023
@dagardner-nv
Fix documentation builds (#1039)
e7911f3 
* 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

Authors:
  - David Gardner (https://github.com/dagardner-nv)
  - Michael Demoret (https://github.com/mdemoret-nv)

Approvers:
  - Devin Robison (https://github.com/drobison00)
  - Michael Demoret (https://github.com/mdemoret-nv)

URL: #1039
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dagardner-nv dagardner-nv

Labels
bug Something isn't working
Projects
Morpheus Boards
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Fix documentation builds dagardner-nv/Morpheus
2 participants
@mdemoret-nv @dagardner-nv