Hi Team Are there any projects or examples how to use `kedro

Question

Hi Team Are there any projects or examples how to use `kedro build docs` effectively The Spaceflights tutorial is pretty minimalist and works in that you can see the pipelines and nodes but how is this used to document parameters or inputs and outputs in greater detail Thank you

datajoely · Answer

Hi < Sean Westgate> so `build docs` is a pretty thin wrapper on top of the standard sphinx build process and is there just to get people up and running The convention for documenting parameters is to do so via the reamdme md created in the pipeline directory This is a manual process today unfortunately but maybe not tomorrow

datajoely · Answer

you can then reference those readmes explicitly in your sphinx toctree

Sean Westgate · Answer

OK I will have a play with that Do you know of any projects listed in the community repo that do this well so I can have a peek

Sean Westgate · Answer

Oh just noticed DeprecationWarning Command kedro build docs is deprecated and will not be available from Kedro 0 19 0 so better to do this outside Kedro then Many thanks

datajoely · Answer

+1

Jo Stichbury · Answer

If you re thinking of project documentation outside of Kedro < Sean Westgate> there s always Github pages I m also interested in as something to try out