-
Notifications
You must be signed in to change notification settings - Fork 833
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
fix: update the docs generation script #1528
Conversation
scripts/docs-v2.sh
Outdated
@@ -1,11 +0,0 @@ | |||
#!/usr/bin/env bash |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
Codecov ReportAll modified and coverable lines are covered by tests ✅
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. |
There was a problem hiding this 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
Summary
This PR aims to update the
pdoc3
dependency used to update the generate the documentationIt 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 arequirements
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[ ]
)/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[ ]
)python3 -m venv .venv && source .venv/bin/activate && ./scripts/run_validation.sh
after making the changes.