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.

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

Fixing FAQs doc per issue #2204 #2351

Merged
merged 16 commits into from
May 22, 2023
Merged

Fixing FAQs doc per issue #2204 #2351

merged 16 commits into from
May 22, 2023

Conversation

sekyondaMeta
Copy link
Contributor

Description

Please read our CONTRIBUTING.md prior to creating your first pull request.

Please include a summary of the feature or issue being fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes #2204

Type of change

Please delete options that are not relevant.

  • Bug fix (non-breaking change which fixes an issue)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • New feature (non-breaking change which adds functionality)
  • This change requires a documentation update

Feature/Issue validation/testing

Updated FAQs page to correct broken links. This started with issue #2204 but found a couple more links to be updated.
Also updated 3 Index links to go to the pytorch website instead of github. This is is a cleaner solution for the .md sphinx issue.

Tested by building site locally and previewing the different pages. Attached screenshot of of the tests.

Screenshot 2023-05-17 at 10 08 12 PM

Checklist:

  • Did you have fun?
  • Have you added tests that prove your fix is effective or that this feature works?
  • Has code been commented, particularly in hard-to-understand areas?
  • Have you made corresponding changes to the documentation?

sekyonda and others added 15 commits May 9, 2023 20:08
Update to fix a broken link in index.md where the trailing .md is cut off from the management_api.md. Added an anchor link to force the .md to show up.
Update to index.md to fix several links ending in .md that sphinx is breaking. Added anchor links to each link and a corresponding anchor in the affected doc. Tested locally and seems to be working.
Fixed typos and updated wordslist.txt
Updated a couple of broken links on the FAQ site per issue pytorch#2204
Updated some links in index.md to go to the pytorch html page instead of github. This is a nicer fix for the .md sphinx issue
@codecov
Copy link

codecov bot commented May 18, 2023

Codecov Report

Merging #2351 (38b772a) into master (77ca82d) will decrease coverage by 0.09%.
The diff coverage is n/a.

❗ Current head 38b772a differs from pull request most recent head e2ef14e. Consider uploading reports for the commit e2ef14e to get more accurate results

@@            Coverage Diff             @@
##           master    #2351      +/-   ##
==========================================
- Coverage   69.44%   69.36%   -0.09%     
==========================================
  Files          77       77              
  Lines        3450     3450              
  Branches       57       57              
==========================================
- Hits         2396     2393       -3     
- Misses       1051     1054       +3     
  Partials        3        3              

see 1 file with indirect coverage changes

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@msaroufim msaroufim requested review from lxning, namannandan, agunapal and msaroufim and removed request for lxning and namannandan May 18, 2023 03:41
@agunapal agunapal merged commit 4450287 into pytorch:master May 22, 2023
9 checks passed
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.

Custom API documentation is missing
4 participants