1849084 - Documentation issue on mozbase/moznetwork

Status: RESOLVED FIXED

(Developer Infrastructure :: Firefox Source Docs: Content, defect)

Description

[Logan Rosen [:Logan]]

URL = https://firefox-source-docs.mozilla.org/mozbase/moznetwork.html

The moznetwork documentation is broken. It doesn't describe the module or contain the main available get_ip() method. This seems to be due to the following exception during the doc build process:

[task 2023-08-17T03:38:32.942Z] WARNING: autodoc: failed to import method 'moznetwork.get_ip' from module 'moznetwork'; the following exception was raised:
[task 2023-08-17T03:38:32.943Z] Traceback (most recent call last):
[task 2023-08-17T03:38:32.943Z]   File "/builds/worker/.mozbuild/srcdirs/gecko-8a5b87fe5d69/_virtualenvs/docs/lib/python3.9/site-packages/sphinx/util/inspect.py", line 376, in safe_getattr
[task 2023-08-17T03:38:32.943Z]     return getattr(obj, name, *defargs)
[task 2023-08-17T03:38:32.943Z] AttributeError: module 'moznetwork' has no attribute 'moznetwork'
[task 2023-08-17T03:38:32.943Z] 
[task 2023-08-17T03:38:32.943Z] The above exception was the direct cause of the following exception:
[task 2023-08-17T03:38:32.943Z] 
[task 2023-08-17T03:38:32.943Z] Traceback (most recent call last):
[task 2023-08-17T03:38:32.943Z]   File "/builds/worker/.mozbuild/srcdirs/gecko-8a5b87fe5d69/_virtualenvs/docs/lib/python3.9/site-packages/sphinx/ext/autodoc/importer.py", line 98, in import_object
[task 2023-08-17T03:38:32.943Z]     obj = attrgetter(obj, mangled_name)
[task 2023-08-17T03:38:32.943Z]   File "/builds/worker/.mozbuild/srcdirs/gecko-8a5b87fe5d69/_virtualenvs/docs/lib/python3.9/site-packages/sphinx/ext/autodoc/__init__.py", line 306, in get_attr
[task 2023-08-17T03:38:32.943Z]     return autodoc_attrgetter(self.env.app, obj, name, *defargs)
[task 2023-08-17T03:38:32.943Z]   File "/builds/worker/.mozbuild/srcdirs/gecko-8a5b87fe5d69/_virtualenvs/docs/lib/python3.9/site-packages/sphinx/ext/autodoc/__init__.py", line 2794, in autodoc_attrgetter
[task 2023-08-17T03:38:32.943Z]     return safe_getattr(obj, name, *defargs)
[task 2023-08-17T03:38:32.943Z]   File "/builds/worker/.mozbuild/srcdirs/gecko-8a5b87fe5d69/_virtualenvs/docs/lib/python3.9/site-packages/sphinx/util/inspect.py", line 392, in safe_getattr
[task 2023-08-17T03:38:32.943Z]     raise AttributeError(name) from exc
[task 2023-08-17T03:38:32.943Z] AttributeError: moznetwork

Comment 1

[Logan Rosen [:Logan]]

Attachment: Bug 1849084 - fix moznetwork doc generation r?#perftest-reviewers

Comment 2

[Sylvestre Ledru [:Sylvestre]]

i wonder if we shouldn't break the build when this happens

Comment 3

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/ff76b3966dcb
fix moznetwork doc generation r=firefox-source-docs-reviewers,sylvestre DONTBUILD

Comment 4

[Iulian Moraru]

https://hg.mozilla.org/mozilla-central/rev/ff76b3966dcb

Comment 5

[Logan Rosen [:Logan]]

(In reply to Sylvestre Ledru [:Sylvestre] PTO from comment #2)

i wonder if we shouldn't break the build when this happens

I believe that would involve passing the -W flag to sphinx-build, which treats all warnings as errors. However, there would then be quite a few warnings/errors to work through before the build started succeeding again. :)