[topgen] Fix broken pinmux table link #21696
Conversation
msfschaffner
force-pushed
the
pinmux-links
branch
from
9dabf3f
to
48d2b45
Compare
msfschaffner
changed the title
msfschaffner
force-pushed
the
pinmux-links
branch
from
48d2b45
to
c3d9a99
Compare
| | CW340 | 4 | 47 | 14 | 13 | 74 | [Pinout Table](./pinout_cw340.md) | | ||
| | Target Name | #IO Banks | #Muxed Pads | #Direct Pads | #Manual Pads | #Total Pads | Pinout / Pinmux Tables | | ||
| |:-------------:|:-----------:|:-------------:|:--------------:|:--------------:|:-------------:|:---------------------------------------------------------------------------:| | ||
| | ASIC | 4 | 47 | 14 | 10 | 71 | [Pinout Table](../../../top_earlgrey/ip/pinmux/doc/autogen/pinout_asic.md) | |
There was a problem hiding this comment.
Hm... actually, is this the right number of directory changes? It looks to me like this new link wouldn't resolve.
Also, did you find a broken link on the website? It was working for me.
There was a problem hiding this comment.
It seems like this would break the top-level documentation here: https://opentitan.org/book/hw/top_earlgrey/ip/pinmux/doc/autogen/targets.html
There was a problem hiding this comment.
There are two scripts, I believe. One that generates top-level docs, and one for the IP itself. The latter is broken:
https://opentitan.org/book/hw/ip/pinmux/doc/programmers_guide.html#top_earlgrey-pinmux-targets
There was a problem hiding this comment.
Ah I see now that this table is reused here:
https://opentitan.org/book/hw/top_earlgrey/ip/pinmux/doc/autogen/targets.html
That was not how this was initially intended.
There was a problem hiding this comment.
I'm feeling like the top-level documentation is already fine, but it's the IP-level that is broken (which is referenced in the issue you linked). Should we consider eliminating the top-level-specific pin-out table from the IP docs instead?
opentitan/hw/ip/pinmux/doc/programmers_guide.md
Lines 109 to 115 in c3d9a99
There was a problem hiding this comment.
Yeah that may be the easier fix. Let me do that.
There was a problem hiding this comment.
Updated - PTAL
a-will
dismissed
their stale review
Prematurely clicked approve. Some outstanding discussion items. :)
Removes the top-dependent tables from the IP documentation and refers to the top-level specific docs. Signed-off-by: Michael Schaffner <[email protected]>
msfschaffner
force-pushed
the
pinmux-links
branch
from
c3d9a99
to
a001697
Compare
This is a short term fix and addresses #18585 and #19425.
Longer term, we should align how top-level documentation is generated, see #12848.