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

Minor documentation improvements #2746

Merged
merged 8 commits into from
Jan 10, 2025
Merged

Minor documentation improvements #2746

merged 8 commits into from
Jan 10, 2025

Conversation

sloria
Copy link
Member

@sloria sloria commented Jan 10, 2025 •
edited
Loading

Some minor documentation improvements:

  • Add warnings for API that will be removed in v4
  • Add opengraph tags
  • Add favicon
  • Add copy buttons to code blocks
  • Use type hints for automatically documenting param types (via sphinx.ext.autodoc.typehints)

@sloria sloria enabled auto-merge (squash) January 10, 2025 18:15
@sloria sloria disabled auto-merge January 10, 2025 18:15
@sloria sloria merged commit 83c409d into 3.x-line Jan 10, 2025
9 checks passed
@sloria sloria deleted the docs branch January 10, 2025 19:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@sloria