docs: move description list render logic into quartodoc #1725
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
machow
commented
Oct 10, 2024
shiny/input_handler.py
Outdated
| @@ -52,18 +52,6 @@ def _process_value( | |||
| for more information on how to create custom input bindings. (The article is about | |||
| Shiny for R, but the JavaScript and general principles are the same.) | |||
|
|
|||
| Methods | |||
There was a problem hiding this comment.
I think I deleted this while pairing w/ Barret, but can put back in. I think it caused griffe to error when parsing the docstring (but could be wrong).
machow
commented
Oct 10, 2024
| @@ -279,7 +258,7 @@ def read_file(file: str | Path, root_dir: str | Path | None = None) -> FileConte | |||
|
|
|||
|
|
|||
| def check_if_missing_expected_example(el, converted): | |||
| if re.search(r"(^|\n)#{2,6} Examples\n", converted): | |||
| if re.search(r"(^|\n)#{2,6} Examples", converted): | |||
There was a problem hiding this comment.
quartodoc adds class names to the sections now, so we had to remove the newline from the regex.
|
Closing in favor of #1727 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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: