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.
Type of PR
Is your Pull Request linked to an existing Issue or Pull Request?
Tags onto #1590.
Give a brief description for the solution you have provided
Fixes an issue (at least for me) in which the generated docs tables (splink_datasets, comparison_library, etc.) weren't being generated locally.
This would then cause the if statement
if [[ ! -f "docs/includes/generated_files/comparison_level_library_dialect_table.md" ]]
to continuously trigger if you were to run the docs builder repeatedly (which frustratingly installs all Splink dependencies through poetry).The issue is with the way in which filepaths and imports are working in the table generation scripts. The fix below simply takes advantage of the poetry creation bash script. With the changes below, Splink is now built and then installed using poetry, rather than trying to use and resolve all of the splink dev dependencies before creating the docs.
This should be quicker, install less fluff and most importantly, fix the main issue causing the tables not to be created by installing Splink directly.
Local build looks like so: