Page MenuHomeSoftware Heritage
Create Task
Maniphest T3648

Fix swh-docs's broken dev build
Closed, MigratedEdits Locked
Actions

Description

Build [1] has been broken for days, probably more.

WARNING: autodoc: failed to import module 'setup' from module 'swh.loader.cvs.rcsparse'; the following exception was raised:
No module named 'swh.loader.cvs.rcsparse.setup'; 'swh.loader.cvs.rcsparse' is not a package
/home/jenkins/workspace/DDOC/dev/swh-docs/docs/swh-loader.rst:6: WARNING: duplicated entry found in toctree: swh-loader-cvs/index
/home/jenkins/workspace/DDOC/dev/swh-docs/docs/apidoc/swh.loader.cvs.rcsparse.setup.rst: WARNING: document isn't included in any toctree
/home/jenkins/workspace/DDOC/dev/swh-docs/docs/swh-perfecthash/index.rst: WARNING: document isn't included in any toctree
/home/jenkins/workspace/DDOC/dev/swh-docs/docs/swh-vault/getting-started.rst:24: WARNING: undefined label: persistent-identifier

[1] https://jenkins.softwareheritage.org/job/DDOC/job/dev/6791/console

Revisions and Commits

rDDOC Development documentation
D6464rDDOC2dbdfdf521bd sysadm/mirror-operations: Fix nonexisting document warning
D6464rDDOCe61e144cad40 sysadm: Fix toctree contains reference to nonexisting document
D6464rDDOCe96db5c48130 sysadm: Fix undefined label warning
rDDOC8a6834df3b8e docs/swh-loader: Drop duplicated entry

Related Objects

Event Timeline

ardumont triaged this task as Normal priority.Oct 12 2021, 9:44 AM
ardumont created this task.
ardumont mentioned this in rDDOC666ef251a846: sphinx: Ignore swh-perfecthash/index.rst for now.Oct 12 2021, 9:44 AM
ardumont mentioned this in rDVAUdcd412a9c126: sphinx: Fix reference to persistent-identifier.
ardumont added a commit: rDDOC8a6834df3b8e: docs/swh-loader: Drop duplicated entry.Oct 12 2021, 9:45 AM
ardumont updated the task description. (Show Details)Oct 12 2021, 9:59 AM
ardumont mentioned this in rDVAUe2d3f274fbe4: sphinx: Fix reference to persistent-identifiers.Oct 12 2021, 10:12 AM
ardumont mentioned this in rDDOCc805b03c5a92: sphinx: Bypass swh.loader.cvs.rcsparse for building docs.
ardumont mentioned this in rDDOC4f95fdca69d2: sphinx: Ignore swh-perfecthash/README.rst.
ardumont mentioned this in rDDOCcab4a6c0aebc: sphinx: Ignore some more unneeded toctree reference.Oct 12 2021, 10:44 AM
ardumont added a revision: D6464: sysadm: Fix remaining warning on sysadm docs.Oct 13 2021, 10:12 AM
ardumont added a commit: rDDOCe96db5c48130: sysadm: Fix undefined label warning.Oct 13 2021, 10:14 AM
ardumont added a commit: rDDOCe61e144cad40: sysadm: Fix toctree contains reference to nonexisting document.
ardumont added a commit: rDDOC2dbdfdf521bd: sysadm/mirror-operations: Fix nonexisting document warning.
ardumont mentioned this in rDDOC5dd615c57dc4: Fix document isn't included in any toctree warning.Oct 13 2021, 5:40 PM
ardumont mentioned this in rDDOC42976e4f5e6a: contributing-docs: Fix links rendering and typos.Oct 14 2021, 2:44 PM
ardumont mentioned this in rDDOC7b92f0ba1845: docs: Ignore some more swh.loader.cvs.rcsparse.setup.Oct 14 2021, 2:52 PM
ardumont mentioned this in rDDOC71df4b74e9c5: Fix Bullet list ends without a blank line; unexpected unindent.Oct 14 2021, 3:19 PM
ardumont added a subscriber: anlambert.Oct 14 2021, 6:18 PM

/me *sigh* it's still red...

That really should be a team effort, to strive to keep our builds green.
So for this build, i concur with @anlambert, we should make it build during diff.

15:14 <+anlambert> ardumont: in order to catch sphinx issues in swh-docs, I was thinking of running the swh-docs/dev Jenkins job when submitting a diff to swh-docs. I think we only need to setup a new harbomaster build plan for that (https://forge.softwareheritage.org/harbormaster/plan/).
15:14 <+ardumont> anlambert: yes, that'd be good because i'm still on T3648 and that's really frustrating

@anlambert thx for the suggestion ^

anlambert added a comment.Oct 14 2021, 6:43 PM
In T3648#72310, @ardumont wrote:

/me *sigh* it's still red...

That really should be a team effort, to strive to keep our builds green.
So for this build, i concur with @anlambert, we should make it build during diff.

15:14 <+anlambert> ardumont: in order to catch sphinx issues in swh-docs, I was thinking of running the swh-docs/dev Jenkins job when submitting a diff to swh-docs. I think we only need to setup a new harbomaster build plan for that (https://forge.softwareheritage.org/harbormaster/plan/).
15:14 <+ardumont> anlambert: yes, that'd be good because i'm still on T3648 and that's really frustrating

@anlambert thx for the suggestion ^

Looks like the only remaining warning is the following: WARNING: A mocked object is detected: 'swh.loader.cvs.rcsparse'.

Regarding setting up a CI build for the dev documentation when submitting diffs to swh-docs, thinking it back some adaptations
will also be needed in the Jenkins jobs configuration for swh-docs/dev in order to add some parameters (diff id, ...) and communicate Jenkins
job links and test results back to Phabricator.

I think we should also trigger the swh-docs/publish Jenkins job when pushing changes to master.

ardumont added a comment.Oct 15 2021, 9:01 AM

Looks like the only remaining warning is the following: WARNING: A mocked object is
detected: 'swh.loader.cvs.rcsparse'.

Yes, and that's because there are some mock setup about it. I tentatively prevented that
module swh.loader.cvs.rcsparse to build because being "autodoc" detected, it creates
other problems on its own (that's one of the initial problem inlined in the
description).

I don't know what the proper fix for that module is. It's installed within the
swh.loader.cvs module but it has its own swh.loader.cvs.rcparse module (with setup.py).

Regarding setting up a CI build for the dev documentation when submitting diffs to
swh-docs, thinking it back some adaptations will also be needed in the Jenkins jobs
configuration for swh-docs/dev in order to add some parameters (diff id, ...) and
communicate Jenkins job links and test results back to Phabricator.

probably

I think we should also trigger the swh-docs/publish Jenkins job when pushing changes
to master.

That might be quite a lot especially on period where we tend to push a lot of docs. But
maybe, we can for that build, only trigger that publish step on the head commit. I
guess, we'll have to see how that goes to decide.

ardumont added a comment.EditedOct 15 2021, 9:02 AM

Note that activating that build on diff will take some time...
I mean the build sphinx-dev takes a long time to finish.

ardumont mentioned this in T3661: docs: Activate build on docs diff.Oct 15 2021, 9:04 AM
ardumont mentioned this in rDDOC015a2b07ad8f: Drop swh.loader.cvs.rcsparse from autodoc_mock_imports settings.Oct 15 2021, 9:37 AM
ardumont closed this task as Resolved.Oct 15 2021, 10:03 AM
ardumont claimed this task.

It's finally green! Closing this.

I've created the task about activating the build on docs diff in T3661.

[1] https://jenkins.softwareheritage.org/job/DDOC/job/dev/6823/console

gitlab-migration changed the task status from Resolved to Migrated.Jan 8 2023, 4:35 PM
gitlab-migration claimed this task.
gitlab-migration added a subscriber: gitlab-migration.

This task has been migrated to GitLab.

About · Developer information · Legal