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

fix: update the docs generation script #1528

Merged

Conversation

WilliamBergamin
Copy link
Contributor

Summary

This PR aims to update the pdoc3 dependency used to update the generate the documentation

It seems like pdoc3==0.11.1 changes the output of the generated documentation.

This PR pins the version of pdoc3 and other documentation related dependencies in a requirements file where @dependabot will be able to maintain them.

The changes also include the latest generated documentation for the project. Notably there is much less source code present in the generated output.

Category (place an x in each of the [ ])

  • slack_sdk.web.WebClient (sync/async) (Web API client)
  • slack_sdk.webhook.WebhookClient (sync/async) (Incoming Webhook, response_url sender)
  • slack_sdk.socket_mode (Socket Mode client)
  • slack_sdk.signature (Request Signature Verifier)
  • slack_sdk.oauth (OAuth Flow Utilities)
  • slack_sdk.models (UI component builders)
  • slack_sdk.scim (SCIM API client)
  • slack_sdk.audit_logs (Audit Logs API client)
  • slack_sdk.rtm_v2 (RTM client)
  • /docs-src (Documents, have you run ./scripts/docs.sh?)
  • /docs-src-v2 (Documents, have you run ./scripts/docs-v2.sh?)
  • /tutorial (PythOnBoardingBot tutorial)
  • tests/integration_tests (Automated tests for this library)

Requirements (place an x in each [ ])

  • I've read and understood the Contributing Guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've run python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh after making the changes.

@WilliamBergamin WilliamBergamin added the docs M-T: Documentation work only label Jul 4, 2024
@WilliamBergamin WilliamBergamin added this to the 3.31.1 milestone Jul 4, 2024
@WilliamBergamin WilliamBergamin self-assigned this Jul 4, 2024
@@ -1,11 +0,0 @@
#!/usr/bin/env bash
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@seratch Ive removed this file since I cannot find a reference to it, but let me know if it is still used somewhere?

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@WilliamBergamin Yes, this is still used (rarely though!). The v2 document is live here: https://slack.dev/python-slackclient/ and the contents are available in this private repo: https://github.com/slackapi/slackapi.github.io/tree/master/python-slackclient There is no guide in this repo (that's not good, sorry!) but we manually copy the generated outputs to the python-slackclient directory. We can delete this operation in the future (say, a few years later) but to me it sounds a bit early to do so today.

Copy link
Contributor Author

@WilliamBergamin WilliamBergamin Jul 5, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ohh I didn't know this page was still available, it makes sense to leave the docs and generation script in the project until we can retire slackclient

Copy link

codecov bot commented Jul 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 84.96%. Comparing base (5c12f7d) to head (5c0e206).

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1528   +/-   ##
=======================================
  Coverage   84.96%   84.96%           
=======================================
  Files         113      113           
  Lines       12498    12498           
=======================================
  Hits        10619    10619           
  Misses       1879     1879           

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

Copy link
Member

@seratch seratch left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

After reverting the v2 script deletion, you can merge this PR

@WilliamBergamin WilliamBergamin merged commit 6369e08 into slackapi:main Jul 5, 2024
12 checks passed
@WilliamBergamin WilliamBergamin deleted the updated-docs-generation branch July 5, 2024 14:36
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants