sphinx_pushfeedback 0.1.5

Feedback widget for Sphinx.

Feedback widget for Sphinx documentation sites.

Installation

1. Create a PushFeedback account.

2. Install sphinx-pushfeedback using PIP.

   pip install sphinx-pushfeedback

3. Add the extension to your Sphinx project conf.py file.

   extensions = ['sphinx_pushfeedback']

4. Configure your project ID in the conf.py 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.

For advanced configuration options, see Sphinx PushFeedback documentation.

License

Copyright (c) 2023 PushFeedback.com Licensed under the MIT License.