Skip to content

Add exclude-doctools option#1069

Merged
dgarcia360 merged 1 commit intoscylladb:masterfrom
dgarcia360:exclude-doctools
Apr 12, 2024
Merged

Add exclude-doctools option#1069
dgarcia360 merged 1 commit intoscylladb:masterfrom
dgarcia360:exclude-doctools

Conversation

@dgarcia360
Copy link
Copy Markdown
Collaborator

@dgarcia360 dgarcia360 commented Apr 9, 2024

Motivation

Adds the option to not load the doctools.js script injected automatically by Sphinx.

We need this option to make the theme compatible with Swagger UI compatible with the 1.2 spec.

How to test

  1. Add the :exclude-doctools: at the top of any RST page.
  2. Build the docs.
  3. Open the page edited in the browser.
  4. Inspect the code and search for "doctools.js". You should not see any results.
  5. Go to a different page and search for "doctools.js". You should get one result.

@dgarcia360 dgarcia360 requested a review from annastuchlik April 9, 2024 11:57
Copy link
Copy Markdown
Collaborator

@annastuchlik annastuchlik left a comment

Choose a reason for hiding this comment

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

Tested with the procedure provided in the description.
LGTM

@dgarcia360 dgarcia360 merged commit b303775 into scylladb:master Apr 12, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants