Closed dkfellows closed 1 year ago
the source is https://readthedocs.org/projects/spinnakermanchester/builds then pick a build and select View raw
The warnings in the second group are all resolved to the correct target; I've checked.
The :noindex:
-related warnings in the first group seem to be handled well enough without trying to figure out how to do better.
I can't see any problem from the missing link (first line).
Summary: A bunch of minor problems but they seem to be handled OK by whatever Sphinx is doing. We don't need to take action; it would just be to reduce the number of warnings so that genuine problems are easier to find in the future.
I found a number of issue some NOT minor.
Our .readthedocs.yaml had become outdated. issue - setup.py was not being run fix- Nuke them and use the advance settings gui on readthedocs instead.
Some repositories had a self dependency. issue - due to the above that was needed to trigger setup. fix - remove now that above in place.
the unfiltered-files.txt files had fallen behind issue sp files where not being documented. fix: changed it to a KISS method that looks for imports in init files. DANGER: Assumes we dont have fancy init files.
spynnaker/pyNN/external_devices/init.py and spynnaker/pyNN/external_devices_models/push_bot/parameters/init.py both imported PushBotRetinaResolution issue: WARNING: more than one target found for cross-reference fix: exclude spynnaker/pyNN/external_devices/init.py note: this hack is needed even if unfiltered-files.txt was kept
The wanted_files in the conf.py had also fallen behind. same fix as above.
so far 4 semantic sugar inits where found.
Notes on the fix and also other things tried has been added to the conf.py for whoever looks again in 6 months time.
These are warnings from the build of the full documentation tree (stripped of some of the less interesting bits of paths). Most are duplicate links. (There were other warnings that don't matter.)