API documentation

[haircutt]

Created api.md, and explored the use of Sphinx autodoc and autofunc to start creating api documentation.

[haircutt]

Pipeline errors w/ regards to the API look to be correctly running now - the two failing pipelines appear to be from other tests

[iosonofabio]

Fixed the bug on CI from my end and merged main into this PR, let's see if it passes CI and we can take it from there

[iosonofabio]

I have added some improvements to the structure, docstrings, and toctree. I've also added a section on data providers which is really important because this aims to be a universal input library that layouts any network.

Could you please take a look, pull into your local branch, and then try to improve further from here?

Thanks!

[iosonofabio]

Thanks @haircutt

why is there featureTable.md but also feature_table.md? Please fix and also decide how people are going to find the table from the doc homepage.

[haircutt]

why is there featureTable.md but also feature_table.md? Please fix and also decide how people are going to find the table from the doc homepage.

featureTable should have been renamed to feature_table.md, resolved now

[iosonofabio]

... and the other issue?

…

On Thu, Apr 23, 2026, at 16:53, Jess wrote: *haircutt* left a comment (fabilab/ilayoutx#4) <#4?email_source=notifications&email_token=AAJFEAFELLD6AAX26DW235D4XG4WHA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIMZQGIZDSOBWG4ZKM4TFMFZW63VHMNXW23LFNZ2KKZLWMVXHJNLQOJPWG33NNVSW45C7N5YGK3S7MNWGSY3L#issuecomment-4302298672> > why is there `featureTable.md` but also `feature_table.md`? Please fix and also decide how people are going to find the table from the doc homepage. > featureTable should have been renamed to feature_table.md, resolved now — Reply to this email directly, view it on GitHub <#4?email_source=notifications&email_token=AAJFEAFELLD6AAX26DW235D4XG4WHA5CNFSNUABFM5UWIORPF5TWS5BNNB2WEL2JONZXKZKDN5WW2ZLOOQXTIMZQGIZDSOBWG4ZKM4TFMFZW63VHMNXW23LFNZ2KKZLWMVXHJNLQOJPWG33NNVSW45C7N5YGK3S7MNWGSY3L#issuecomment-4302298672>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJFEAERVRQCHJW4QEZYIST4XG4WHAVCNFSM6AAAAACWSY5X5CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DGMBSGI4TQNRXGI>. You are receiving this because you commented.Message ID: ***@***.***>

[haircutt]

... and the other issue?

Should have added this correctly now

[iosonofabio]

the second issue is still the same: how are people expected to find the table when they browse the documentation home page?

Maybe you could add a short sentence and a link on the main API page?

[haircutt]

the second issue is still the same: how are people expected to find the table when they browse the documentation home page?

Maybe you could add a short sentence and a link on the main API page?

I see, I tried to add the page to the nav tab originally, but have also incorporated a link into the API page now

[iosonofabio]

Just pinging that a few items from the code review look like they are still pending, can you please check out the review above and reply to the individual requests? Thanks

[haircutt]

Finalised for review - API documentation and feature table

[iosonofabio]

ahem, @haircutt the review issues above and in the "Files changes" tab seem all still there, therefore it is not finalised. Can you please take a look? Or we can meet up and go through them in person

[iosonofabio]

Also as a quick heads-up, I have pushed a few commits to main to add some centering and rotating options. It would be great if you could, in addition to take a look at the reviews (see previous comment), also:

• pull main into this branch with the latest commits
• update the feature table based on the new parameters (just a few new supported options, should not take too long)

Thank you!

[haircutt]

ahem, @haircutt the review issues above and in the "Files changes" tab seem all still there, therefore it is not finalised. Can you please take a look? Or we can meet up and go through them in person

Can I come in Friday to clarify what I was supposed to do? 😅may have misinterpreted

[iosonofabio]

Sure

…

On Wed, May 6, 2026, at 16:16, Jess wrote: *haircutt* left a comment (fabilab/ilayoutx#4) <#4 (comment)> > ahem, @haircutt <https://github.com/haircutt> the review issues above and in the "Files changes" tab seem all still there, therefore it is not finalised. Can you please take a look? Or we can meet up and go through them in person > Can I come in Friday to clarify what I was supposed to do? 😅may have misinterpreted — Reply to this email directly, view it on GitHub <#4 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/AAJFEABJ3WSUGU5JDBDFOG34ZLKFFAVCNFSM6AAAAACWSY5X5CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHM2DGOBVGU3TOMJVG4>. Triage notifications on the go with GitHub Mobile for iOS <https://apps.apple.com/app/apple-store/id1477376905?ct=notification-email&mt=8&pt=524675> or Android <https://play.google.com/store/apps/details?id=com.github.android&referrer=utm_campaign%3Dnotification-email%26utm_medium%3Demail%26utm_source%3Dgithub>. You are receiving this because you commented.Message ID: ***@***.***>

[iosonofabio]

Please check you really need these imports?

[haircutt]

the docs appear to fail in build without these, there is use of os, path and sys calls in the try blocks below, unless the link_github should be set to false?

[iosonofabio]

Thank you!! Great job!