Add wiring reference docs

[chrishalcrow]

Hello,

Here's a draft for adding reference docs for the wiring pathways from wirings.py. Idea is to add a .pdf and .xlsx for each wiring, so it's easy for users/maintainers to check wiring when we need. Here I've included one of the seven wirings.

The spreadsheet contains all the intermediate steps for the wiring, while the pdf contains links to the company websites and figures so that you can re-generate the spreadsheet yourself.

Some design choices:

• Decided to make the pdf using latex to avoid messing around with vector graphics software.
• I've put all the reference stuff in docs/imgs resources/wiring_references but maybe there's a better place?
• I added a link to the automatic wiring doc page

I've collated all the data, so just need some feedback on design/etc before making all the pdfs.

Don't think you'll be able to see the files in the draft docs, so here they are:

ASSY-77>Adpt.A64-Om32_2x-sm-NN>RHD2164.pdf
ASSY-77>Adpt.A64-Om32_2x-sm-NN>RHD2164.xlsx

[alejoe91]

Thansk @chrishalcrow

Looking great! I think I would add it to a separate resources folder, since it's not strictly speaking part of the docs. What do you think?

[chrishalcrow]

Thansk @chrishalcrow

Looking great! I think I would add it to a separate resources folder, since it's not strictly speaking part of the docs. What do you think?

Sounds reasonable. I had added a new docs page. Instead, do you think it should just live on the repo without documentation? Or maybe just a link to the repo folder on one of the other pages (like here: https://probeinterface.readthedocs.io/en/latest/examples/ex_11_automatic_wiring.html)?

[alejoe91]

Is it normal to get a 404 page not found when clicking on the links? Or is this because the build is from the PR?

[chrishalcrow]

Is it normal to get a 404 page not found when clicking on the links? Or is this because the build is from the PR?

It's because it's from the PR

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 89.58%. Comparing base (48d759b) to head (201e0ab).
Report is 6 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff             @@
##             main     #315      +/-   ##
==========================================
+ Coverage   89.46%   89.58%   +0.11%     
==========================================
  Files          11       12       +1     
  Lines        1899     1939      +40     
==========================================
+ Hits         1699     1737      +38     
- Misses        200      202       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[chrishalcrow]

@alejoe91 @samuelgarcia all the pdfs/xlsxs are in the probeinterface/resources/wiring_references folder. Now there's just a reference to this folder in the docs, rather than a new page. I haven't added the Cambridge NeuroTech mini-amp because the pdf isn't publicly available. We can discuss little details at the si meeting later?