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

Documentation updates #526

Merged
merged 9 commits into from
Nov 17, 2023
Merged

Documentation updates #526

merged 9 commits into from
Nov 17, 2023

Conversation

JWCook
Copy link
Member

@JWCook JWCook commented Nov 17, 2023

Updates #432

  • Update issue and PR templates
  • Only link to stable release docs
  • Hide list of release versions from main page toctree
  • Use sphinx-design dropdown instead of custom toggle class
  • Add OpenGraph metadata
  • Include class summary in automodule docs
  • Split user guide into basic and advanced usage
  • Add user guide for API client class

@JWCook JWCook added the docs Documentation-related issues label Nov 17, 2023
@JWCook JWCook added this to the v0.19 milestone Nov 17, 2023
Copy link

codecov bot commented Nov 17, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (80bd3a1) 96.35% compared to head (568be52) 96.35%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #526   +/-   ##
=======================================
  Coverage   96.35%   96.35%           
=======================================
  Files          58       58           
  Lines        3294     3296    +2     
  Branches      643      643           
=======================================
+ Hits         3174     3176    +2     
  Misses         88       88           
  Partials       32       32           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@JWCook JWCook marked this pull request as ready for review November 17, 2023 23:27
@JWCook JWCook merged commit db58d6a into main Nov 17, 2023
7 checks passed
@JWCook JWCook deleted the docs branch November 17, 2023 23:28
JWCook added a commit that referenced this pull request Dec 11, 2023
JWCook added a commit that referenced this pull request Dec 11, 2023
JWCook added a commit that referenced this pull request Dec 11, 2023
JWCook added a commit that referenced this pull request Dec 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Documentation-related issues
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant