Skip to content

Add sphinx extension for kwargs #6780

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.

Sign up for GitHub

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

Jump to bottom
Merged
kristapratico merged 1 commit into from
Aug 13, 2019
Merged

Add sphinx extension for kwargs #6780

kristapratico merged 1 commit into from
Aug 13, 2019

Conversation

@kristapratico
Copy link
Contributor

@kristapratico kristapratico commented Aug 13, 2019

This extension will allow us to use :keyword: to document our kwargs in the docstrings and will show up in the documentation like this:
kwarg

@kristapratico kristapratico added Docs EngSys This issue is impacting the engineering system. labels Aug 13, 2019
@kristapratico kristapratico requested a review from scbedd August 13, 2019 16:49
@adxsdk6
Copy link

adxsdk6 commented Aug 13, 2019

Can one of the admins verify this patch?

scbedd
scbedd approved these changes Aug 13, 2019
View reviewed changes
Copy link
Member

@scbedd scbedd left a comment

Choose a reason for hiding this comment

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

👍

@kristapratico kristapratico merged commit 31bb82c into Azure:master Aug 13, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@scbedd scbedd scbedd approved these changes

Assignees

No one assigned

Labels

Docs EngSys This issue is impacting the engineering system.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

3 participants

@kristapratico @adxsdk6 @scbedd