python-slack-sdk icon indicating copy to clipboard operation
python-slack-sdk copied to clipboard

Intersphinx Docs No Longer being Published

Open chalbersma opened this issue 1 year ago • 2 comments
trafficstars

Intersphinx index used to be published here https://slack.dev/python-slack-sdk/objects.inv. It's no longer being published. Intersphinx is useful. Please put it back.

The page URLs

https://slack.dev/python-slack-sdk/objects.inv

chalbersma avatar Aug 14 '24 17:08 chalbersma

Hi @chalbersma 👋 Thanks for raising this - it appears that the documentation migration from *.rst to *.md in #1537 removed Intersphinx support 😓

I understand that this might be breaking a workflow you have and I'm exploring how we might support objects.inv once more with our current toolchain.

This also isn't so ideal, but as a workaround I would suggest using the build outputs from v3.31.0 at this URL: https://github.com/slackapi/python-slack-sdk/raw/v3.31.0/docs/objects.inv

zimeg avatar Aug 14 '24 21:08 zimeg

I would also love to have the inventory back. I don't use Sphinx, but MkDocs Material together with MkDocstrings, which allows loading of inventories as well.

I'm maintainer of Slack Machine, which is a library to build extensible Slack bots. In the docs I like to refer to the Slack SDK API reference sometimes.

DonDebonair avatar Nov 21 '24 14:11 DonDebonair