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

Rework cookbook #149

Merged
merged 29 commits into from
Jan 13, 2023
Merged

Rework cookbook #149

merged 29 commits into from
Jan 13, 2023

Conversation

digitaldogsbody
Copy link
Member

@digitaldogsbody digitaldogsbody commented Dec 24, 2022

  • Reformats the existing cookbook examples per @giacomomarchioro's suggestion to use a table for the recipe+json links
  • Adds a brief introduction to the cookbook docs
  • Adds the awesome-pages plugin and uses it to autogenerate the navigation for the cookbook recipes
  • Moves existing cookbook recipe python to separate files and updates recipes
  • Enables pymdownx.snippets to load compile python code into the markdown
  • Adds a script in utils/ that checks the validity of the cookbook recipes
  • Adds a new workflow that calls the script
  • Adds recipe doc + code for 0017-transcription-av
  • Adds recipe doc + code for 0230-navdate
  • Updates the AutoFields helper to allow the AutoLabel magic to work on other classes that have .label properties (Allow AutoLabel to work in other places that have a .label property #155)
  • Includes the changes from Fix serialization errors with datetime etc #151 and Fix skeleton modifier bug + add ManifestRef changes #154 due to basing/branching fun. They should be merged first, and if either is changed before merge, there might be conflicts.

Closes #155

@digitaldogsbody
Copy link
Member Author

Once this is merged, the instructions in #129 will need to be updated a bit and the cookbook_skeletons branch updated to pre-enter the likely snippet names for convenience

@digitaldogsbody digitaldogsbody changed the title Reformat cookbook examples Rework cookbook Dec 27, 2022
Copy link
Contributor

@giacomomarchioro giacomomarchioro left a comment

Choose a reason for hiding this comment

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

It looks great! Immense work. I'm just curious, why not consider test_cookbook an integration test and run it using unittest?

@digitaldogsbody digitaldogsbody merged commit 2513180 into main Jan 13, 2023
@digitaldogsbody digitaldogsbody deleted the reformat_cookbook branch January 13, 2023 14:34
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.

Allow AutoLabel to work in other places that have a .label property
2 participants