dwave-ocean-sdk icon indicating copy to clipboard operation
dwave-ocean-sdk copied to clipboard

Published 20 hours ago • verified publisher icon dwavesystems

Clean up non-submodule build warnings

Open JoelPasvolsky opened this issue 8 months ago • 6 comments

Currently building Ocean SDK with make html produces close to 150 warnings, a majority of type WARNING: more than one target found for cross-reference. This causes two problems:

  1. Links across modules are to an arbitrary target of the several similarly named properties (e.g. dimod and dwave-hybrid SampleSet or various nodelist attributes).
  2. We miss new significant warnings because no one is looking through 150 warnings

We had originally accepted these warnings out of the expectation that Sphinx would strengthen inheritance disambiguation but this GitHub issue on Sphinx is now two years old.

The updates in this and the following PRs reduce the number of warnings from ~150 to under 20:

JoelPasvolsky avatar Jun 21 '24 20:06 JoelPasvolsky