prefect icon indicating copy to clipboard operation
prefect copied to clipboard

Automate the building of the 3.x SDK docs

Open chrisguidry opened this issue 1 year ago • 3 comments

Until Mintlify supports SDK documentation natively, we're going to generate our SDK documentation with Mkdocs (updated text here) and publish to a fairly bare-bones Netlify project (https://prefect-python-sdk-docs.netlify.app/). We want to automate this process enough that we'll have accurate/usable SDK docs (even if they aren't the most beautiful they will end up being)

chrisguidry avatar Jun 12 '24 18:06 chrisguidry

Update, pdoc seems pretty barebones and didn't seem to recurse through our module hierarchy very well. I did a spike with mkdocs and was able to get a pretty solid foundation going in just a couple hours or so. https://github.com/PrefectHQ/prefect/pull/14012

chrisguidry avatar Jun 13 '24 20:06 chrisguidry

Moving this off the 3.x last mile board, as docs have been built here. Still want to automate in the future.

discdiver avatar Jun 24 '24 14:06 discdiver

Once #14292 is merged and Netlify is connected to auto-build on changes to the "site" folder in prefecthq/prefect, just need to run the command make docs upon Prefect 3.x releases in a GitHub Action.

discdiver avatar Jun 24 '24 18:06 discdiver