Skip to content

Docs: disable Read the Docs flyout without using CSS #15851

Open
@humitos

Description

@humitos

Describe the bug

I found that you are hiding the Read the Docs flyout shown at the bottom right by using CSS in this line: https://github.com/pypi/warehouse/blob/main/docs/user/stylesheets/extra.css#L13 and there is no need to do it via CSS. You can simple disable it from the Read the Docs dashboard with a checkbox.

Expected behavior

The flyout can be disabled from the dashboard without requiring any coding. Just:

  1. Go to the https://beta.readthedocs.org/dashboard/docspypiorg/edit/
  2. Click on "Addons (Beta)" from the left bar
  3. Uncheck "Flyout enabled"
  4. Done 👍🏼

To Reproduce

  1. Go to https://docs.pypi.org/
  2. Inspect the DOM and see that readthedocs-flyout element has the property display: none;

Additional context

Note that Read the Docs is free for Open Source projects. The flyout, besides providing extra features to the readers, was our1 way to tell users the site was hosted by Read the Docs and promote our platform more broadly. Since we added the ability to hide the flyout on projects, we may eventually ask users to show some support here communicating the hosting provider in some way. Similar to what CPython's theme is doing by showing "Hosted on Read the Docs" at the bottom right (see python/python-docs-theme#165). This is not required, but it would be pretty much appreciated 🙏🏼

Footnotes

  1. I work at Read the Docs 😃

Metadata

Metadata

Assignees

No one assigned

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions