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

Recipe Gallery Sphinx Directive #1150

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open

Recipe Gallery Sphinx Directive #1150

wants to merge 13 commits into from

Conversation

jakeymac
Copy link
Contributor

This pull request adds a sphinx directive for recipe galleries

These galleries can be in one of two formats: Multi-Row or Carousel

Multi-Row places the desired recipe tiles into a grid of 4 columns.

Carousel adds a sliding carousel where each slide has 4 recipe tiles visible at a time (if there are at least 4 cards to show)

This directive also adds a search input to search for different tags in the recipe cards and filter for those tags.

@jakeymac jakeymac self-assigned this Jan 25, 2025
@coveralls
Copy link

coveralls commented Jan 25, 2025

Coverage Status

coverage: 100.0%. remained the same
when pulling f51708f on recipe_gallery
into 411c87d on main.

Fixed bug in logic for checking bounds in recipe gallery carousel
@jakeymac jakeymac marked this pull request as ready for review January 28, 2025 22:46
Comment on lines 7 to 10
/* TODO TESTING DELETE THIS */
#recipe-tag-search-bar {
border: 1px solid black;
}
Copy link
Member

Choose a reason for hiding this comment

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

You should probably delete this...

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This style will be left in for now, just for testing in the recipes.rst file

docs/index.rst Outdated
@@ -79,6 +79,7 @@ App Development

tutorials
dev_guides
recipes
Copy link
Member

Choose a reason for hiding this comment

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

Move this above tutorials

Copy link
Contributor Author

Choose a reason for hiding this comment

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

done

.. recipe-gallery::
:layout: multi-row

recipes/first_recipe images/recipes/address_searching.png "Address Search Recipe" [search, address, location, map, geocoding]
Copy link
Member

Choose a reason for hiding this comment

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

Is it possible to get the title from the first heading in the page it is referencing? I think that is how the toctrees work.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

This is resolved in commit f51708f

updated recipe gallery cards to pull title from target documents
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.

3 participants