Skip to content
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

docs(deps): up sphinx to 3.4.3, add napoleon_attr_annotations=True #1691

Merged
merged 4 commits into from
Feb 23, 2021
Merged

docs(deps): up sphinx to 3.4.3, add napoleon_attr_annotations=True #1691

merged 4 commits into from
Feb 23, 2021

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Feb 23, 2021

Part of #1665

Description:

  • upgrade sphinx to 3.4.3
  • add napoleon_attr_annotations=True in conf.py

Check list:

  • New tests are added (if a new feature is added)
  • New doc strings: description and/or example code are in RST format
  • Documentation is updated (if required)

vfdev-5
vfdev-5 approved these changes Feb 23, 2021
View reviewed changes
Copy link
Collaborator

@vfdev-5 vfdev-5 left a comment

Choose a reason for hiding this comment

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

Thanks @ydcjeff !

@vfdev-5 vfdev-5 merged commit fdcadcd into pytorch:master Feb 23, 2021
@ydcjeff ydcjeff deleted the ydcjeff-patch-1 branch February 23, 2021 15:41
@vfdev-5
Copy link
Collaborator

vfdev-5 commented Feb 24, 2021 •
edited
Loading

It's funny that the preview does not show

Notes[ + ]

Package Reference[ + ]

Contrib Package Reference[ + ]

Team[ + ]

the way how the docs looks like now. @ydcjeff any ideas on how to keep the previous rendering with Package Reference, Contrib Package Reference and Team always expanded ?

@ydcjeff
Copy link
Contributor Author

ydcjeff commented Feb 25, 2021 •
edited
Loading

I think it is related to the recent changes of pytorch_sphinx_theme

pytorch/pytorch_sphinx_theme#87

@vfdev-5 vfdev-5 mentioned this pull request Feb 25, 2021
Closed
@vfdev-5
Copy link
Collaborator

vfdev-5 commented Feb 28, 2021

@ydcjeff so should we do something with it ?

vfdev-5 pushed a commit that referenced this pull request Mar 1, 2021
@vfdev-5
docs(deps): up sphinx to 3.4.3, add napoleon_attr_annotations=True (#…
a1276f4 
…1691)

* Update requirements.txt

* Update conf.py

* sphinx==3.4.3
@ydcjeff ydcjeff mentioned this pull request Mar 1, 2021
Merged
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vfdev-5 vfdev-5 vfdev-5 approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@ydcjeff @vfdev-5