Updates scripts and folders to create SDK docs for Prefect and all integration libraries using Mkdocs - Githubissues

PrefectHQ / prefect

Prefect is a workflow orchestration framework for building resilient data pipelines in Python.

https://prefect.io

Apache License 2.0

15.94k stars 1.56k forks source link

Updates scripts and folders to create SDK docs for Prefect and all integration libraries using Mkdocs #14076

Closed discdiver closed 3 months ago

discdiver commented 3 months ago

SDK docs are live on [Netlify[(https://prefect-python-sdk-docs.netlify.app/).

To create a new version of the SDK docs:

Run python scripts/generate_sdk_docs.py with the latest editable versions of Prefect and the integration libraries installed.
Run mkdocs build.
Upload the resulting "site" folder to Netlify.

Will work on automating this process in the future.

Example

Screenshot 2024-06-17 at 10 56 15 AM

Checklist

[ ] This pull request references any related issue by including "closes <link to issue>"
- If no issue exists and your change is not a small fix, please create an issue first.
[ ] If this pull request adds new functionality, it includes unit tests that cover the changes
[X] This pull request includes a label categorizing the change e.g. maintenance, fix, feature, enhancement, docs.

For documentation changes:

[ ] This pull request includes redirect settings in mint.json for files that are removed or renamed.

For new functions or classes in the Python SDK:

[ ] This pull request includes helpful docstrings.
[ ] If a new Python file was added, this pull request contains a stub page in the Python SDK docs and an entry in docs/mint.json navigation.