Closed barneydobson closed 1 month ago
@dalonsoa will update tabulate
... ~I will check but I'm pretty sure the relative links seem to work differently in mkdocs-jupyter
~
@dalonsoa yep when I serve this locally the link works. I didn't figure out why but I'm sure when I first made the documentation while the 'normal' mkdocs
way of referencing (reference-model.md#wsimod.orchestration.model.to_datetime
) worked locally I seem to remember it not working when deployed..
We can change every link to remove these warnings... but there's a chance it won't work when deployed and we'll have to change them back. On the live website the warned link still works
Summary
details
. My preferred option would be to use this API like in this, which feels much tidier in terms of formatting and more sustainable as code does not need to be reproduced. But as we discussed in SWMManywhere - it seems thatmkdocs-jupyter
can't access the API docstrings. I could use ayaml
codeblock, which would include thepython
formatting, but it looks super weird as it is formatted differently from the notebook and can't be stored in adetails
. Thus, I think this is the best way, but am open to suggesstions.scripts
folder as in the another demo withos
- though it's a bit ugly. Obviously__file__
would be preferrable, but this doesn't seem to work withmkdocs-jupyter
.river_discharge_order
.Fixes #112