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

docs(): generate docs for our Python SDK #7612

Merged
merged 19 commits into from
Mar 29, 2023

Conversation

hsheth2
Copy link
Collaborator

@hsheth2 hsheth2 commented Mar 16, 2023

It looks a little something like this:

image

  • I've manually picked a few modules that I consider to be part of our public interface for the initial version, but it's extremely easy to add more.
  • This will set up the scaffolding for us to autogenerate CLI reference material too.

Issues

  • Not sure if this is the best place to put these in the docs - perhaps we need a "reference" section?
  • The autogenerated docs pages can be pretty long and hence hard to navigate.

Checklist

  • The PR conforms to DataHub's Contributing Guideline (particularly Commit Message Format)
  • Links to related issues (if applicable)
  • Tests for the changes have been added/updated (if applicable)
  • Docs related to the changes have been added/updated (if applicable). If a new feature has been added a Usage Guide has been added for the same.
  • For any breaking change/potential downtime/deprecation/big changes an entry has been made in Updating DataHub

@github-actions github-actions bot added the ingestion PR or Issue related to the ingestion of metadata label Mar 16, 2023
@laulpogan
Copy link
Contributor

I'd have them live under python sdk in tools as "SDK reference"
We could thinking about moving the SDK's into the API bucket too

@hsheth2 hsheth2 requested a review from laulpogan March 23, 2023 15:56
@hsheth2
Copy link
Collaborator Author

hsheth2 commented Mar 23, 2023

@laulpogan I've moved them to a Python SDK Reference section

Let me know what you think - we can use the vercel live preview now :)

Copy link
Collaborator

@jjoyce0510 jjoyce0510 left a comment

Choose a reason for hiding this comment

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

Margin between classes could make things a bit more readable... Let's see if our friend Jeff can take a look

@hsheth2 hsheth2 merged commit 2eb9fe4 into datahub-project:master Mar 29, 2023
@hsheth2 hsheth2 deleted the sphinx-docs branch March 29, 2023 03:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ingestion PR or Issue related to the ingestion of metadata
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants