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 community card #143

Merged
merged 4 commits into from Oct 13, 2020
Merged

Add community card #143

merged 4 commits into from Oct 13, 2020

Conversation

josh146
Copy link
Member

@josh146 josh146 commented Oct 1, 2020

Provides a custom ReST directive for creating a community card:

.. community-card::
    :title: card title
    :author: author (or subtitle?)
    :date: 30/09/2020
    :code: https://github.com/username/repo/or/notebook
    :paper: https://arxiv.org/abs/1234568
    :color: teal

    The demo description goes here. This field can contain HTML if needed, for example images and links.
    Of the options above, only title, author, and date are required. Code, paper, and color are all optional.

This will help reduce the overhead of adding community demos.

Note that this PR should result in no front-facing webpage changes.

Copy link
Contributor

@mariaschuld mariaschuld left a comment

Choose a reason for hiding this comment

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

That will be very helpful. The card looks nice (even though not from this PR).

@glassnotes
Copy link
Contributor

They look so nice! ⭐

I'm trying to test it out by adding a new block in demos_community.rst, but I cannot get anything to show up (using make html-norun). Are there any additional steps?

@josh146
Copy link
Member Author

josh146 commented Oct 1, 2020

@glassnotes thanks for the help offline fixing this! The makefile should now build to the same directories in both norun and run mode

Copy link
Contributor

@thisac thisac left a comment

Choose a reason for hiding this comment

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

Didn't notice the community card that was added yesterday, but it nice that we're beginning to fill this up already. Looks great! 💯

@co9olguy co9olguy removed their request for review October 1, 2020 15:37
@josh146
Copy link
Member Author

josh146 commented Oct 3, 2020

Due to feedback, I've slightly modified the card design, to make the links to the paper/code more obvious:

image

@josh146 josh146 merged commit 30c5f23 into master Oct 13, 2020
@josh146 josh146 deleted the add-community-card branch October 13, 2020 07:44
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.

None yet

4 participants