search

executablebooks / sphinx-panels

A sphinx extension for creating panels in a grid layout
https://sphinx-panels.readthedocs.io
MIT License
83 stars 20 forks source link

Panels and Tabs don't work with dirhtml on ReadTheDocs #48

Closed pradyunsg closed 3 years ago

pradyunsg commented 3 years ago

Describe the bug

When building with the dirhtml setting on ReadTheDocs, the post-transforms for this project are not triggered.

To Reproduce

Steps to reproduce the behavior:

  1. Make a project on RTD.
  2. Use the web Admin UI to select the "Dirhtml" builder.
  3. Make a build w/ this project.
  4. See the raw HTML that matches what you expect pre-transform.

Expected behavior

The post-transforms are triggered, even on ReadTheDocs.

Environment

Additional context

See https://github.com/readthedocs/readthedocs.org/blob/b74fe8d5aab8421fb194d7b8cbbb42a4e54f2569/readthedocs/doc_builder/backends/sphinx.py#L352

ReadTheDocs can use one of 3 potential only-on-RTD builder names, and this package only supports 1 of those. The "correct" list would be as per https://github.com/pradyunsg/sphinx-inline-tabs/commit/ace2f951ab9a1f0627e70b828a57ef3dd2386bf0.