Try to make the docs a little better. #524
Merged
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
- Fix stardoc adding <p align=center> in markdown tables. - Add rough capability to handle macros that wrap a rule. The wrapping technique is: - In the wrapping macro, use the docstring @wraps(some_rule) - Then we don't emit the docs for the wrapper - In the docs for some_rule, replace the string "some_rule" with the name of the wrapper macro. It is a first attempt to make things better. It is crude, but it mostly works.
nacl
approved these changes
Feb 15, 2022
| CENTER_RE = re.compile(r'<p align="center">([^<]*)</p>') | ||
|
|
||
|
|
||
| def merge_file(file: str, out, wrapper_map:typing.Dict[str, str]) -> None: |
There was a problem hiding this comment.
This forces use of python 3.6 or newer. Not that it's a problem, but this might cause interesting problems on older platforms. Guess we'll deal with them if/when they appear.
dannysullivan
approved these changes
Feb 16, 2022
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.
<p align=center>in markdown tables.The wrapping technique is:
It is a first attempt to make things better. It is crude, but it mostly works. If Stardoc ever adds this capability (feature request) we can move to that.