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

Add quickstart docs with simplest workflow #72

Merged
merged 3 commits into from
Apr 15, 2023
Merged

Conversation

Iain-S
Copy link
Collaborator

@Iain-S Iain-S commented Apr 11, 2023

This PR aims to document the simplest possible workflow:

  • make tables, make generators, create tables & create data
  • No vocab
  • No stats
  • No config file

Even though it is good to keep a quickstart simple, I do think that we should add at least two more examples, to show the use of the stats and vocab functions. I think it should be fine to do that in separate PRs, though.

@Iain-S Iain-S requested a review from myyong April 11, 2023 14:16
@Iain-S Iain-S force-pushed the iain-s/quickstart branch from e38960f to 0bbbf3e Compare April 11, 2023 14:37
@Iain-S
Copy link
Collaborator Author

Iain-S commented Apr 11, 2023

You can see the docs here https://sqlsynthgen--72.org.readthedocs.build/en/72/

Copy link
Collaborator

@myyong myyong left a comment

Choose a reason for hiding this comment

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

Do you want to keep the sphinx dependencies where they are or move them over the dev dependencies?

@Iain-S
Copy link
Collaborator Author

Iain-S commented Apr 15, 2023

For whatever reason, it isn't possible to do the optional-extras trick for dependencies in the dev group so they have to live in the main one.

@Iain-S Iain-S merged commit c057d50 into main Apr 15, 2023
@Iain-S Iain-S deleted the iain-s/quickstart branch April 15, 2023 13:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants