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
techdocs: Update example documentation #4983
Conversation
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
|
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Possible discovered TechDocs bugs?
That's why we need such a rich page examples with all MkDocs extensions being rendered properly (or not)! Thanks 😁
def getUsersInGroup( targetGroup, secure = False ): | ||
|
||
if __debug__: | ||
print ('targetGroup=[' + targetGroup + ']') |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
def getUsersInGroup( targetGroup, secure = False ): | |
if __debug__: | |
print ('targetGroup=[' + targetGroup + ']') | |
def getUsersInGroup(targetGroup, secure=False): | |
if __debug__: | |
print('targetGroup=[' + targetGroup + ']') |
PEP8 speaks in my head :D
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'm still old school two spaces after a period kinda guy, it's so hard not to hit the spacebar ha ha
Signed-off-by: Adam Harvey <adam.harvey@dxc.com>
Signed-off-by: Adam Harvey adam.harvey@dxc.com
Fixes #4237
Hey, I just made a Pull Request!
Adds a few more examples to better showcase what TechDocs provides out of the box.
Fixes the code example and also adds Python:
Adds a showcase of more of the features, such as admonitions, PlantUML, and pymdown extensions:
Possible discovered TechDocs bugs?
Many images from these extensions look broken to me on my localhost. I see a CSS error in the React console relating to the mimetype, but I feel like that is separate. The admonition icons aren't showing up for me, neither are the check marks for the task list. However, the emojis look fine?
So I have a feeling my screen shots are accurate, but just might represent a separate bug that perhaps the plugin is not correctly rendering images from the Pymdown extensions?
I'd say also I expected the warning admonition to be a different color, so that may be a CSS trick we're missing there. From the source project it looks like:
But renders blue in TechDocs.
✔️ Checklist
Signed-off-by
line in the message. (more info)