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: use autosummary generated docs, add nitpicky mode #1780

Merged
merged 12 commits into from
Mar 13, 2021
Merged

docs: use autosummary generated docs, add nitpicky mode #1780

merged 12 commits into from
Mar 13, 2021

Conversation

ydcjeff
Copy link
Contributor

@ydcjeff ydcjeff commented Mar 13, 2021 •
edited
Loading

Fixes #1766

https://deploy-preview-1780--pytorch-ignite-preview.netlify.app

Description:

  • use autosummary generated docs for {engine,handlers,distributed,metrics,contrib/metrics,contrib/handlers}.rst
  • fix math equation rendering by pinning katex at 0.13.0
  • add nitpicky mode to check cross reference internal links (-n in docs.yml)
  • fix the cross reference according to nitpicky mode
  • ignore some external package links which don't exist
  • add missing docstrings

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)

@github-actions github-actions bot added ci CI docs module: contrib Contrib module module: distributed Distributed module labels Mar 13, 2021
@vfdev-5 vfdev-5 removed module: contrib Contrib module module: distributed Distributed module labels Mar 13, 2021
@github-actions github-actions bot added module: contrib Contrib module module: distributed Distributed module module: engine Engine module module: handlers Core Handlers module module: metrics Metrics module labels Mar 13, 2021
@ydcjeff ydcjeff changed the title Autosummary docs: use autosummary generated docs, add nitpicky mode Mar 13, 2021
@ydcjeff ydcjeff requested a review from vfdev-5 March 13, 2021 17:28
@vfdev-5 vfdev-5 removed module: contrib Contrib module module: distributed Distributed module module: engine Engine module module: handlers Core Handlers module module: metrics Metrics module labels Mar 13, 2021
@github-actions github-actions bot added the module: contrib Contrib module label Mar 13, 2021
@github-actions github-actions bot added module: distributed Distributed module module: engine Engine module module: handlers Core Handlers module module: metrics Metrics module labels Mar 13, 2021
@vfdev-5 vfdev-5 requested a review from trsvchn March 13, 2021 17:36
trsvchn
trsvchn approved these changes Mar 13, 2021
View reviewed changes
docs/source/faq.rst Show resolved Hide resolved
@trsvchn
Copy link
Collaborator

trsvchn commented Mar 13, 2021

Thanks for the PR @ydcjeff LGTM! I left a comment about small nit)

@vfdev-5 vfdev-5 removed module: contrib Contrib module module: distributed Distributed module module: engine Engine module module: handlers Core Handlers module module: metrics Metrics module labels Mar 13, 2021
vfdev-5
vfdev-5 approved these changes Mar 13, 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 a lot @ydcjeff for the PR and @trsvchn for the review !

@vfdev-5 vfdev-5 merged commit bd4ea89 into pytorch:master Mar 13, 2021
@ydcjeff ydcjeff deleted the autosummary branch March 14, 2021 02:46
@ydcjeff
Copy link
Contributor Author

ydcjeff commented Mar 14, 2021

A corresponding PR to docsearch-configs : algolia/docsearch-configs#3796

@vfdev-5 vfdev-5 mentioned this pull request Mar 14, 2021
Open
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@trsvchn trsvchn trsvchn approved these changes

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

Assignees
No one assigned
Labels
ci CI docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

improve documentation search results
3 participants
@ydcjeff @trsvchn @vfdev-5