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 Refactor #1714

Merged
merged 9 commits into from Oct 21, 2022
Merged

Docs Refactor #1714

merged 9 commits into from Oct 21, 2022

Conversation

BobDotCom
Copy link
Member

@BobDotCom BobDotCom commented Oct 19, 2022 •
edited

Summary

  • Categorizes API Reference for faster load times
  • Upgrades to Sphinx v5
  • Include new changelog in docs
  • Minor changes

Information

  • This PR fixes an issue.
  • This PR adds something new (e.g. new method or parameters).
  • This PR is a breaking change (e.g. methods or parameters removed/renamed).
  • This PR is not a code change (e.g. documentation, README, typehinting,
    examples, ...).

Checklist

  • I have searched the open pull requests for duplicates.
  • If code changes were made then they have been tested.
    • I have updated the documentation to reflect the changes.
  • If type: ignore comments were used, a comment is also left explaining why.

@BobDotCom BobDotCom added documentation Improvements or additions to documentation priority: low Low Priority status: in progress Work in Progess labels Oct 19, 2022
@BobDotCom BobDotCom self-assigned this Oct 19, 2022
plun1331
plun1331 previously approved these changes Oct 19, 2022
View reviewed changes
@Middledot Middledot linked an issue Oct 20, 2022 that may be closed by this pull request
Upgrade Sphinx and Split api.rst #1607
Closed
@BobDotCom BobDotCom changed the title Break api reference into categories [docs] Categorize API Reference & Upgrade Sphinx to v5 Oct 20, 2022
@BobDotCom BobDotCom changed the title [docs] Categorize API Reference & Upgrade Sphinx to v5 Docs Refactor Oct 20, 2022
@BobDotCom BobDotCom mentioned this pull request Oct 20, 2022
Closed
@BobDotCom BobDotCom marked this pull request as ready for review October 21, 2022 02:18
@BobDotCom BobDotCom enabled auto-merge (squash) October 21, 2022 02:18
@BobDotCom BobDotCom requested review from a team, FrostByte266, WhoIsConch and Middledot and removed request for a team October 21, 2022 02:25
@BobDotCom BobDotCom merged commit ebc9b28 into master Oct 21, 2022
@BobDotCom BobDotCom deleted the refactor-docs branch October 21, 2022 03:19
@JustaSqu1d JustaSqu1d mentioned this pull request Dec 11, 2023
Open
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Lulalaby Lulalaby Lulalaby approved these changes

@ChickenDevs ChickenDevs ChickenDevs approved these changes

@plun1331 plun1331 plun1331 left review comments

@FrostByte266 FrostByte266 Awaiting requested review from FrostByte266 FrostByte266 is a code owner automatically assigned from Pycord-Development/maintainers

@WhoIsConch WhoIsConch Awaiting requested review from WhoIsConch WhoIsConch is a code owner automatically assigned from Pycord-Development/maintainers

@Middledot Middledot Awaiting requested review from Middledot Middledot is a code owner automatically assigned from Pycord-Development/maintainers

Assignees

@BobDotCom BobDotCom

Labels
documentation Improvements or additions to documentation priority: low Low Priority status: in progress Work in Progess
Projects
Pycord Releases
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Upgrade Sphinx and Split api.rst
4 participants
@BobDotCom @Lulalaby @plun1331 @ChickenDevs