Feedback widget for Sphinx

PushFeedback collects user feedback directly from your website. This guide covers installation in a Sphinx project using PIP.

Prerequisites

Before you begin, you need:

• 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.

Installation

1. Install the Sphinx extension:

   pip install sphinx-pushfeedback

2. Add the extension to your Sphinx project's conf.py file:

   extensions ['sphinx_pushfeedback']

3. Configure your project ID in the conf.py file:

   pushfeedback_project = '<YOUR_PROJECT_ID>'
   pushfeedback_feedback_button_text = "Feedback"

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

4. 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.

Customization

Add any configuration option to your conf.py 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"