Skip to content

docs: use latest quartodoc to make description lists #427

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

Merged
merged 4 commits into from
Oct 10, 2024

Conversation

machow
Copy link
Collaborator

@machow machow commented Aug 30, 2024

This PR uses the main branch of quartodoc to start wiring up an alternative style of listing parameters. This format is meant to fix the issue of the description column being very narrow on mobile.

Expand to see some screenshots

Basic example

old new
image image

Narrow display

old new
image image

@rich-iannone do you mind picking up and making sure it styles to your liking?! We can change anything in quartodoc and are living on the bleeding edge 😄. I noticed just now the display of defaults has a bug (title is a required paramter, but the new style is showing = None).

Copy link

codecov bot commented Aug 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 87.86%. Comparing base (06b1408) to head (4f2ae11).
Report is 37 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #427   +/-   ##
=======================================
  Coverage   87.86%   87.86%           
=======================================
  Files          42       42           
  Lines        4852     4852           
=======================================
  Hits         4263     4263           
  Misses        589      589           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@github-actions github-actions bot temporarily deployed to pr-427 August 30, 2024 18:26 Destroyed
@rich-iannone
Copy link
Member

I think this can be merged as is! Thank you for making this possible.

@machow
Copy link
Collaborator Author

machow commented Sep 9, 2024

I'm going to try plugging quartodoc description lists into py-shiny this week as a sanity check, so once that's done will circle back, release in quartodoc, and merge here!

@github-actions github-actions bot temporarily deployed to pr-427 October 10, 2024 16:55 Destroyed
@github-actions github-actions bot temporarily deployed to pr-427 October 10, 2024 17:03 Destroyed
Copy link
Member

@rich-iannone rich-iannone left a comment

Choose a reason for hiding this comment

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

LGTM!

@machow machow merged commit 1ad3ec1 into main Oct 10, 2024
13 checks passed
@machow machow deleted the docs-description-lists branch October 10, 2024 19:41
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.

2 participants