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

Docs: Adds Jupyter Book to examples table #9446

Merged
merged 2 commits into from
Jul 25, 2022

Conversation

benjaoming
Copy link
Contributor

@benjaoming benjaoming commented Jul 22, 2022

Not sure how this current example table should look wrt. headline.. proposing to rename it to "List of current example projects", supposing that we might have a list of "outdated" examples or "unmaintained examples".

Before:

image

After:

image

@benjaoming benjaoming requested a review from a team as a code owner July 22, 2022 20:12
@benjaoming benjaoming requested a review from agjohnson July 22, 2022 20:12
@humitos
Copy link
Member

humitos commented Jul 25, 2022

It looks like before/after images are the same? 🤔

@benjaoming
Copy link
Contributor Author

Thanks, updated! The screenshots were definitely also overdoing it :)

Copy link
Contributor

@agjohnson agjohnson left a comment

Choose a reason for hiding this comment

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

🎉

Unrelated to this PR, but this table would probably flow better as a definition list. The table version feels really dense, given it's maybe the focus of this page.

docs/user/examples.rst Outdated Show resolved Hide resolved
Co-authored-by: Anthony <aj@ohess.org>
@benjaoming
Copy link
Contributor Author

@agjohnson I guess that we could embed these columns in a definition list. I am, though, inclined to thinking that it's actually the table functionality that can benefit from improvements. For instance, I have this antique PR 😄 readthedocs/sphinx_rtd_theme#432

@agjohnson
Copy link
Contributor

agjohnson commented Jul 25, 2022

That's a valid, separate topic, but I think this content would look better without the table entirely.

Anyways, that's a separate change either way.

@benjaoming benjaoming merged commit c7cf2d4 into readthedocs:main Jul 25, 2022
@benjaoming benjaoming deleted the add-jupyter-example branch July 25, 2022 18:33
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