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

Intersphinx Docs No Longer being Published #1542

Open
chalbersma opened this issue Aug 14, 2024 · 2 comments
Open

Intersphinx Docs No Longer being Published #1542

chalbersma opened this issue Aug 14, 2024 · 2 comments
Labels
docs M-T: Documentation work only Version: 3x
Milestone

Comments

@chalbersma
Copy link

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

@zimeg zimeg added bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented docs M-T: Documentation work only and removed untriaged labels Aug 14, 2024
@zimeg
Copy link
Member

zimeg commented Aug 14, 2024

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

@seratch seratch added this to the 4.x milestone Aug 19, 2024
@seratch seratch added Version: 3x and removed bug M-T: A confirmed bug report. Issues are confirmed when the reproduction steps are documented labels Aug 19, 2024
@DonDebonair
Copy link

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.

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 Version: 3x
Projects
None yet
Development

No branches or pull requests

4 participants