Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Merged
merged 5 commits into from
Jun 17, 2024

Conversation

discdiver
Copy link
Contributor

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

To create a new version of the SDK docs:

  1. Run python scripts/generate_sdk_docs.py with the latest editable versions of Prefect and the integration libraries installed.
  2. Run mkdocs build.
  3. 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
  • 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.

@discdiver discdiver added the docs label Jun 17, 2024
@discdiver discdiver marked this pull request as ready for review June 17, 2024 15:02
@discdiver discdiver requested review from a team as code owners June 17, 2024 15:02
Copy link
Contributor

@billpalombi billpalombi left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice! Glad you made the wordmark consistent. This is definitely an adequate solution for now.

@discdiver discdiver merged commit 696feeb into main Jun 17, 2024
4 checks passed
@discdiver discdiver deleted the sdk branch June 17, 2024 15:11
Copy link
Collaborator

@chrisguidry chrisguidry left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nice!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants