YosysHQ / yosys

Yosys Open SYnthesis Suite
https://yosyshq.net/yosys/
ISC License
3.5k stars 895 forks source link

Remove make docs race conditions (and other docs fixes) #4635

Closed KrystalDelusion closed 1 month ago

KrystalDelusion commented 1 month ago

What are the reasons/motivation for this change? Fix #4631 Also fix an orphaned page which was one of four warnings triggering read the docs to fail.

Explain how this is achieved. Removing the tidy target from make all was only one part of the issue, the other part was that gen_examples called make all while gen_images called make dots, where dots was always a subset of all. This could lead to a race condition with the opt code example where one make could remove %_full.dot while the other make file was trying to use it (at least, I think that's what the issue was). The prepare-docs job now also runs make docs, which should serve as a smoke test for when read the docs is going to fail. If it is, then there is no point triggering it just to watch it fail.

If applicable, please suggest to reviewers how they can test the change. make docs/prep -j[n>1] from top level makefile should run without error. make docs should also run without error, but as of this writing is expected to fail due to missing help messages in some commands and is reflective of read the docs.