Skip to content

removes duplicated docstring rendering#3651

Merged
wyli merged 4 commits intoProject-MONAI:devfrom
wyli:fixes-sphinx
Jan 13, 2022
Merged

removes duplicated docstring rendering#3651
wyli merged 4 commits intoProject-MONAI:devfrom
wyli:fixes-sphinx

Conversation

@wyli
Copy link
Copy Markdown
Contributor

@wyli wyli commented Jan 12, 2022

Signed-off-by: Wenqi Li [email protected]
Screenshot 2022-01-12 at 23 00 46

Description

for example https://docs.monai.io/en/stable/data.html#iterabledataset
__init__ arguments are rendered twice as the class docstring and __init__ method docstring, this PR removes the duplicated ones

Status

Ready

Types of changes

  • Non-breaking change (fix or new feature that would not break existing functionality).
  • Breaking change (fix or new feature that would cause existing functionality to change).
  • New tests added to cover the changes.
  • Integration tests passed locally by running ./runtests.sh -f -u --net --coverage.
  • Quick tests passed locally by running ./runtests.sh --quick --unittests --disttests.
  • In-line docstrings updated.
  • Documentation updated, tested make html command in the docs/ folder.

Signed-off-by: Wenqi Li <[email protected]>
@wyli wyli requested a review from Nic-Ma January 12, 2022 23:02
@wyli wyli changed the title removed duplicated docstring rendering removes duplicated docstring rendering Jan 12, 2022
@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Jan 12, 2022

as our doc page defaults to the milestone releases, would be great to include this PR in 0.8.1 #3479

Copy link
Copy Markdown
Contributor

@Nic-Ma Nic-Ma left a comment

Choose a reason for hiding this comment

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

Good finding! Thanks for the quick fix, looks good to me.
Is there any preview of the expected web page after building with this PR?

Thanks.

@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Jan 13, 2022

@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Jan 13, 2022

/build

1 similar comment
@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Jan 13, 2022

/build

@wyli
Copy link
Copy Markdown
Contributor Author

wyli commented Jan 13, 2022

/build

@wyli wyli enabled auto-merge (squash) January 13, 2022 17:17
@wyli wyli merged commit ceb71ab into Project-MONAI:dev Jan 13, 2022
wyli added a commit that referenced this pull request Jan 14, 2022
* removed duplicated

Signed-off-by: Wenqi Li <[email protected]>

* update gitignore to ignore readthedocs autobuild

Signed-off-by: Wenqi Li <[email protected]>
@wyli wyli deleted the fixes-sphinx branch April 27, 2022 22:34
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