Skip to main content

Feedback widget for Sphinx

Here's a step-by-step guide to help you install PushFeedback in your Sphinx project.

Feedback wiget for docs screenshot


Before you begin, you'll need to have the following:

  • A PushFeedback account. If you don't have one, sign up for free.
  • A project created in your PushFeedback dashboard. If you haven't created one yet, follow the steps in the Quickstart guide.
  • A Sphinx project.


To integrate the PushFeedback widget into your Sphinx site:

  1. Open your terminal or command prompt. Navigate to your project's root directory using the cd command:

    cd path/to/your/project

    Replace path/to/your/project with your project's actual directory path.

  2. With your terminal still open, run the following command to install PushFeedback via PIP:

    pip install sphinx-pushfeedback
  3. Add the extension to your Sphinx project's file:

    extensions ['sphinx_pushfeedback']
  4. Configure your project ID in the file:

    pushfeedback_project = '<YOUR_PROJECT_ID>'

    Replace <YOUR_PROJECT_ID> with your project's ID from the PushFeedback dashboard.

  5. Build the documentation:

    make html

    Once built, open your documentation in a web browser. Verify that the feedback button appears and works correctly on your site.

    Sphinx Feedback widget

Next steps

You can customize the PushFeedback widget to suit your needs. For example, you can change the widget's position, color, and more.

To do so, you can add any of the following configuration options to your file, with the following modifications:

  1. Prefix configuration options with pushfeedback_. For instance, project would be pushfeedback_project.

  2. Use underscores instead of hyphens as words separator. For example, button-position becomes pushfeedback_button_position.

Here's an example:

pushfeedback_button_style = "light"