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: use upcoming quartodoc description-list option #1727

Merged
merged 7 commits into from
Oct 10, 2024

Conversation

schloerke
Copy link
Collaborator

Continuation of #1725 but under internal branch name of docs- to auto build the docs locally


Recently, quartodoc cribbed the structure shiny used to render parameters in its documentation 😁. This PR attempts to take swap out the existing logic in the shiny docs renderer with quartodoc.

Note that I've set the CI to install quartodoc from main. Once everything looks good here and in this Great Tables PR, I can do a quartodoc release!

Here are some critical changes:

  • Introduced the ParamRow dataclass, to represent a row in a parameter table (prev just used a tuple).
  • Moved sanitization into ParamRow, rather than performing in each render method
  • New!: Added html classes to headers. E.g. "## Examples {.doc-section, .doc-section-examples}

@schloerke
Copy link
Collaborator Author

@machow Merging PR before verifying outputs on website. (Currently main is broken until this PR is merged.)

@schloerke schloerke enabled auto-merge (squash) October 10, 2024 20:04
@schloerke
Copy link
Collaborator Author

Building quartodoc goal achieved. Merging before checks finish

@schloerke schloerke merged commit 81a4192 into main Oct 10, 2024
39 of 40 checks passed
@schloerke schloerke deleted the docs-machow-description-list branch October 10, 2024 20:08
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