Update documentation - #132
Open
yhong123 wants to merge 3 commits into
Open
Conversation
Pin Sphinx and mermaid extension used to build the documentation.\n\nThis file makes it easy to create a virtualenv and install the exact packages tested when running 'make html' in docs. Optional runtime deps that enable autodoc imports are commented out.\n Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Resolved #131
Summary
This PR updates and reorganises the Datafaker documentation to improve clarity, navigation, and onboarding for users. In particular, it adds a new tutorial covering the workflow required by Paul and Shipra for generating synthetic Camino data from Parquet files.
Changes
tutorial_parquet.rst), which serves as the primary guide for Paul and Shipra's use case.duckdb.rst) has been retained for the time being and can be removed later if Tim agrees thattutorial_parquet.rstprovides sufficient coverage.index.rstto:quickstart.rst.installation.rst.loan_data.rst) fromindex.rstbecause the example describes Turing's SqlSynthGen rather than Datafaker.requirements.txtfile for building the Sphinx documentation./datafaker/README.mdto include a link to the documentation GitHub Pages site.Future Work
The "Advanced" section would benefit from additional review and reorganisation. Further documentation improvements can be addressed in a subsequent documentation-focused PR.