https://kedro.org/ logo
#questions
Title
# questions
s

Sean Westgate

11/07/2022, 3:08 PM
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!
d

datajoely

11/07/2022, 3:09 PM
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…
you can then reference those readmes explicitly in your sphinx toctree
s

Sean Westgate

11/07/2022, 3:11 PM
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?
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.
d

datajoely

11/07/2022, 3:38 PM
👍
j

Jo Stichbury

11/08/2022, 10:51 AM
If you're thinking of project documentation outside of Kedro @Sean Westgate there's always Github pages. I'm also interested in https://docsify.js.org/#/ as something to try out.
👍 1
3 Views